Mercurial > sdl-ios-xcode
view src/joystick/darwin/SDL_sysjoystick.c @ 4157:baf615f9f2a0 SDL-1.2
Date: Thu, 16 Oct 2008 20:27:34 +0400
From: "Ilya Kasnacheev" <ilya.kasnacheev@gmail.com>
To: sdl@lists.libsdl.org
Subject: [SDL] SDL for Windows CE: a few GAPI patches
Hi *!
I've just ported a POWDER roguelike ( http://www.zincland.com/powder/ ) to
Windows CE (PDAs, Windows Mobile/Pocket PC). To do that, I had to get libsdl
working. Thanks for the awesome project files, it built without a hitch.
Nevertheless, I've found quite a few bugs in Windows CE (GAPI) SDL
implementation, which I've solved and now present as a serie of patches.
I'll try carefully annotate them. Please annotate them so I can work
toward accepting
them into the main source tree since without them SDL isn't really working on
Windows CE (I wonder why nobody fixed them before, btw: why isn't SDL popular as
a way to develop Windows CE games? Where are no ports?)
These changes can't be considered flawless, but they can be considered working
because I've yet to hear complains about things I fixed and POWDER build for
Windows CE is now considered stable.
Note: my comments start with !!, delete them before applying.
diff -bru SDL-1.2.13/src/video/gapi/SDL_gapivideo.c
SDL-1.2.13-new/src/video/gapi/SDL_gapivideo.c
--- SDL-1.2.13/src/video/gapi/SDL_gapivideo.c 2007-12-31
07:48:00.000000000 +0300
+++ SDL-1.2.13-new/src/video/gapi/SDL_gapivideo.c 2008-10-16
20:02:11.000000000 +0400
@@ -643,6 +643,7 @@
}
gapi->userOrientation = SDL_ORIENTATION_UP;
+ gapi->systemOrientation = SDL_ORIENTATION_UP;
video->flags = SDL_FULLSCREEN; /* Clear flags, GAPI supports
fullscreen only */
/* GAPI or VGA? */
@@ -661,18 +662,21 @@
}
/* detect user landscape mode */
- if( (width > height) && (GetSystemMetrics(SM_CXSCREEN) <
GetSystemMetrics(SM_CYSCREEN)))
+ if( (width > height) && (gapi->gxProperties.cxWidth <
gapi->gxProperties.cyHeight))
gapi->userOrientation = SDL_ORIENTATION_RIGHT;
+ if(GetSystemMetrics(SM_CYSCREEN) < GetSystemMetrics(SM_CXSCREEN))
+ gapi->systemOrientation = SDL_ORIENTATION_RIGHT;
+
/* shall we apply hires fix? for example when we do not use
hires resource */
gapi->hiresFix = 0;
- if( gapi->userOrientation == SDL_ORIENTATION_RIGHT )
+ if( gapi->systemOrientation == gapi->userOrientation )
{
- if( (width > GetSystemMetrics(SM_CYSCREEN)) || (height
> GetSystemMetrics(SM_CXSCREEN)))
+ if( (width > GetSystemMetrics(SM_CXSCREEN)) || (height
> GetSystemMetrics(SM_CYSCREEN)))
gapi->hiresFix = 1;
} else
- if( (width > GetSystemMetrics(SM_CXSCREEN)) || (height
> GetSystemMetrics(SM_CYSCREEN)))
- if( !((width == GetSystemMetrics(SM_CYSCREEN))
&& (height == GetSystemMetrics(SM_CXSCREEN)))) // user portrait,
device landscape
+ if( (width > GetSystemMetrics(SM_CYSCREEN)) || (height
> GetSystemMetrics(SM_CXSCREEN)))
+// if( !((width == gapi->gxProperties.cyHeight)
&& (height == gapi->gxProperties.cxWidth))) // user portrait, device
landscape
gapi->hiresFix = 1;
switch( gapi->userOrientation )
!! It used to query system metrics which return dimensions according to screen
!! orientation, which can really be portrait, left landscape or right landscape.
!! This is presumably incorrect because we couldn't care less about user mode
!! dimensions - all we want are the GAPI framebuffer dimensions, which
only match
!! user dimensions in one of possible orientations.
!! There's a fair dose of cargo cult programming involved in this fix, but it
!! used to work only in one orientation (portrait for PDAs, where frame-buffer
!! have same orientation as user screen), and now it works on all orientations.
@@ -742,21 +746,30 @@
WIN_FlushMessageQueue();
/* Open GAPI display */
- if( !gapi->useVga && this->hidden->useGXOpenDisplay )
+ if( !gapi->useVga && this->hidden->useGXOpenDisplay &&
!this->hidden->alreadyGXOpened )
+ {
+ this->hidden->alreadyGXOpened = 1;
if( !gapi->gxFunc.GXOpenDisplay(SDL_Window, GX_FULLSCREEN) )
{
SDL_SetError("Couldn't initialize GAPI");
return(NULL);
}
+ }
#if REPORT_VIDEO_INFO
printf("Video properties:\n");
printf("display bpp: %d\n", gapi->gxProperties.cBPP);
printf("display width: %d\n", gapi->gxProperties.cxWidth);
printf("display height: %d\n", gapi->gxProperties.cyHeight);
+ printf("system display width: %d\n", GetSystemMetrics(SM_CXSCREEN));
+ printf("system display height: %d\n", GetSystemMetrics(SM_CYSCREEN));
printf("x pitch: %d\n", gapi->gxProperties.cbxPitch);
printf("y pitch: %d\n", gapi->gxProperties.cbyPitch);
printf("gapi flags: 0x%x\n", gapi->gxProperties.ffFormat);
+ printf("user orientation: %d\n", gapi->userOrientation);
+ printf("system orientation: %d\n", gapi->userOrientation);
+ printf("gapi orientation: %d\n", gapi->gapiOrientation);
+
if( !gapi->useVga && this->hidden->useGXOpenDisplay && gapi->needUpdate)
{
!! Previous version used to call gapi->gxFunc.GXOpenDisplay each time the video
!! mode would be changed. You shouldn't, because this call has a
meaning "Lock the
!! GAPI framebuffer, designate it as busy", so the second call will fail (it is
!! already locked/busy).
!! Testing might not find that because most programs set up the video mode only
!! once, but POWDER does this once in a while, so it crashed when in
320x240 mode
!! (640x480 mode doesn't use that code, it worked fine).
diff -bru SDL-1.2.13/src/video/gapi/SDL_gapivideo.h
SDL-1.2.13-new/src/video/gapi/SDL_gapivideo.h
--- SDL-1.2.13/src/video/gapi/SDL_gapivideo.h 2007-12-31
07:48:00.000000000 +0300
+++ SDL-1.2.13-new/src/video/gapi/SDL_gapivideo.h 2008-10-16
20:02:11.000000000 +0400
@@ -132,12 +132,17 @@
#define NUM_MODELISTS 4 /* 8, 16, 24, and 32 bits-per-pixel */
int SDL_nummodes[NUM_MODELISTS];
SDL_Rect **SDL_modelist[NUM_MODELISTS];
+ // The orientation of the video mode user wants to get
+ // Probably restricted to UP and RIGHT
enum SDL_ScreenOrientation userOrientation;
int invert;
char hiresFix; // using hires mode without defining hires resource
// --------------
int useGXOpenDisplay; /* use GXOpenDispplay */
+ int alreadyGXOpened;
int w, h;
+ // The orientation of GAPI framebuffer.
+ // Never changes on the same device.
enum SDL_ScreenOrientation gapiOrientation;
void *buffer; // may be 8, 16, 24, 32 bpp
@@ -153,6 +158,10 @@
int startOffset; // in bytes
int useVga;
int suspended; // do not pu anything into video memory
+ // The orientation of the system, as defined by SM_CXSCREEN
and SM_CYSCREEN
+ // User can change it by using 'screen layout' in system options
+ // Restricted to UP or RIGHT
+ enum SDL_ScreenOrientation systemOrientation;
};
!! This is a flag variable, see the previous comment
!! And yet another orientation: now we have to keep three of them in mind.
diff -bru SDL-1.2.13/src/video/wincommon/SDL_sysevents.c
SDL-1.2.13-new/src/video/wincommon/SDL_sysevents.c
--- SDL-1.2.13/src/video/wincommon/SDL_sysevents.c 2007-12-31
07:48:02.000000000 +0300
+++ SDL-1.2.13-new/src/video/wincommon/SDL_sysevents.c 2008-10-16
20:02:12.000000000 +0400
@@ -160,10 +160,22 @@
#endif */
}
break;
+ // FIXME: Older version used just SDL_VideoSurface->(w, h)
+ // w and h are "clipped" while x and y are "raw", which caused
+ // x in former and y in latter case to be clipped in a
wrong direction,
+ // thus offsetting the coordinate on 2 x clip pixels
+ // (like, 128 for 640 -> 512 clipping).
+ // We will now try to extract and use raw values.
+ // The way to do that RIGHT is do
(orientation-dependent) clipping before
+ // doing this transform, but it's hardly possible.
+
+ // SEE SDL_mouse.c /ClipOffset to understand these calculations.
case SDL_ORIENTATION_RIGHT:
if (!SDL_VideoSurface)
break;
- rotatedX = SDL_VideoSurface->w - *y;
+ rotatedX = (2 *
((SDL_VideoSurface->offset%SDL_VideoSurface->pitch)/
+ SDL_VideoSurface->format->BytesPerPixel))
+ + SDL_VideoSurface->w - *y;
rotatedY = *x;
*x = rotatedX;
*y = rotatedY;
@@ -172,7 +184,8 @@
if (!SDL_VideoSurface)
break;
rotatedX = *y;
- rotatedY = SDL_VideoSurface->h - *x;
+ rotatedY = (2 *
(SDL_VideoSurface->offset/SDL_VideoSurface->pitch))
+ + SDL_VideoSurface->h - *x;
*x = rotatedX;
*y = rotatedY;
break;
!! That's the trickest part, hence the long comment.
!! GAPI would really support only 320x240 or 640x480 mode, if application
!! requested the different screen size (as POWDER did, wishing
256x192), then SDL
!! is going to grab the first mode that fits the requested, and pad the screen
!! with black bars (as they do with wide-screen films).
!! It would also get, say, 240x320 mode, and to turn it into 256x192 it would
!! need to rotate mouse clicks.
!! It worked, but one bug slipped through: it would receive mouse clicks
!! unpadded, then rotate them, and then pad the black bars. The
problem is: rotate
!! is done by GAPI driver while padding is done by SDL core. SDL core
doesn't know
!! anything about rotating, so it would pad one of dimensions incorrectly.
I understand that some of my claims (or code) might seem unbacked, but you can
always grab the POWDER binary, compile your own libsdl with one or more of
those fixes turned off, and see how weird it would misbehave. I can even supply
you with those custom builds of libsdl if you don't want to set up the build
environment for windows ce, you'll just need a PDA or a smartphone with it.
I plan to take care of SDL on Windows CE as long as I maintain the POWDER port.
POWDER is good for that because it:
Employs both padded (with centered image, black bars) and unpadded
(image occupies full screen) graphics; initializes video more than
once; uses both 320x240 and 640x480 video; uses both stylus and
buttons.
There's still a list of unresolved issues which I'm planning to fix:
1) Arrow buttons on PDA return weird scancodes compared to PC, this
caused the game to misbehave before I've fixed that. You can see it on
those diagrams:
http://wrar.name/upload/powder-htc.png
http://wrar.name/upload/powder-pda.png
2) SDL (or underlying windows) doesn't care to rotate arrow presses
when we're in a low-res GAPI mode, but it will rotate them in VGA mode
(because of different screen orientations, the same arrow buttons can
suddently mean different directions). Solution: we should stick to
GAPI user orientation (the orientation the program supposedly wants)
and rotate the keys on our own.
_______________________________________________
SDL mailing list
SDL@lists.libsdl.org
http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 07 Nov 2008 04:15:36 +0000 |
parents | d07c60f5e460 |
children | a1b03ba2fcd0 |
line wrap: on
line source
/* SDL - Simple DirectMedia Layer Copyright (C) 1997-2004 Sam Lantinga This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Sam Lantinga slouken@libsdl.org */ #include "SDL_config.h" #ifdef SDL_JOYSTICK_IOKIT /* SDL joystick driver for Darwin / Mac OS X, based on the IOKit HID API */ /* Written 2001 by Max Horn */ #include <unistd.h> #include <ctype.h> #include <sysexits.h> #include <mach/mach.h> #include <mach/mach_error.h> #include <IOKit/IOKitLib.h> #include <IOKit/IOCFPlugIn.h> #ifdef MACOS_10_0_4 #include <IOKit/hidsystem/IOHIDUsageTables.h> #else /* The header was moved here in Mac OS X 10.1 */ #include <Kernel/IOKit/hidsystem/IOHIDUsageTables.h> #endif #if MAC_OS_X_VERSION_MIN_REQUIRED == 1030 #include "10.3.9-FIX/IOHIDLib.h" #else #include <IOKit/hid/IOHIDLib.h> #endif #include <IOKit/hid/IOHIDKeys.h> #include <CoreFoundation/CoreFoundation.h> #include <Carbon/Carbon.h> /* for NewPtrClear, DisposePtr */ #include "SDL_joystick.h" #include "../SDL_sysjoystick.h" #include "../SDL_joystick_c.h" struct recElement { IOHIDElementCookie cookie; /* unique value which identifies element, will NOT change */ long min; /* reported min value possible */ long max; /* reported max value possible */ #if 0 /* TODO: maybe should handle the following stuff somehow? */ long scaledMin; /* reported scaled min value possible */ long scaledMax; /* reported scaled max value possible */ long size; /* size in bits of data return from element */ Boolean relative; /* are reports relative to last report (deltas) */ Boolean wrapping; /* does element wrap around (one value higher than max is min) */ Boolean nonLinear; /* are the values reported non-linear relative to element movement */ Boolean preferredState; /* does element have a preferred state (such as a button) */ Boolean nullState; /* does element have null state */ #endif /* 0 */ /* runtime variables used for auto-calibration */ long minReport; /* min returned value */ long maxReport; /* max returned value */ struct recElement * pNext; /* next element in list */ }; typedef struct recElement recElement; struct joystick_hwdata { IOHIDDeviceInterface ** interface; /* interface to device, NULL = no interface */ char product[256]; /* name of product */ long usage; /* usage page from IOUSBHID Parser.h which defines general usage */ long usagePage; /* usage within above page from IOUSBHID Parser.h which defines specific usage */ long axes; /* number of axis (calculated, not reported by device) */ long buttons; /* number of buttons (calculated, not reported by device) */ long hats; /* number of hat switches (calculated, not reported by device) */ long elements; /* number of total elements (shouldbe total of above) (calculated, not reported by device) */ recElement* firstAxis; recElement* firstButton; recElement* firstHat; int removed; int uncentered; struct joystick_hwdata* pNext; /* next device */ }; typedef struct joystick_hwdata recDevice; /* Linked list of all available devices */ static recDevice *gpDeviceList = NULL; static void HIDReportErrorNum (char * strError, long numError) { SDL_SetError(strError); } static void HIDGetCollectionElements (CFMutableDictionaryRef deviceProperties, recDevice *pDevice); /* returns current value for element, polling element * will return 0 on error conditions which should be accounted for by application */ static SInt32 HIDGetElementValue (recDevice *pDevice, recElement *pElement) { IOReturn result = kIOReturnSuccess; IOHIDEventStruct hidEvent; hidEvent.value = 0; if (NULL != pDevice && NULL != pElement && NULL != pDevice->interface) { result = (*(pDevice->interface))->getElementValue(pDevice->interface, pElement->cookie, &hidEvent); if (kIOReturnSuccess == result) { /* record min and max for auto calibration */ if (hidEvent.value < pElement->minReport) pElement->minReport = hidEvent.value; if (hidEvent.value > pElement->maxReport) pElement->maxReport = hidEvent.value; } } /* auto user scale */ return hidEvent.value; } static SInt32 HIDScaledCalibratedValue (recDevice *pDevice, recElement *pElement, long min, long max) { float deviceScale = max - min; float readScale = pElement->maxReport - pElement->minReport; SInt32 value = HIDGetElementValue(pDevice, pElement); if (readScale == 0) return value; /* no scaling at all */ else return ((value - pElement->minReport) * deviceScale / readScale) + min; } static void HIDRemovalCallback(void * target, IOReturn result, void * refcon, void * sender) { recDevice *device = (recDevice *) refcon; device->removed = 1; device->uncentered = 1; } /* Create and open an interface to device, required prior to extracting values or building queues. * Note: appliction now owns the device and must close and release it prior to exiting */ static IOReturn HIDCreateOpenDeviceInterface (io_object_t hidDevice, recDevice *pDevice) { IOReturn result = kIOReturnSuccess; HRESULT plugInResult = S_OK; SInt32 score = 0; IOCFPlugInInterface ** ppPlugInInterface = NULL; if (NULL == pDevice->interface) { result = IOCreatePlugInInterfaceForService (hidDevice, kIOHIDDeviceUserClientTypeID, kIOCFPlugInInterfaceID, &ppPlugInInterface, &score); if (kIOReturnSuccess == result) { /* Call a method of the intermediate plug-in to create the device interface */ plugInResult = (*ppPlugInInterface)->QueryInterface (ppPlugInInterface, CFUUIDGetUUIDBytes (kIOHIDDeviceInterfaceID), (void *) &(pDevice->interface)); if (S_OK != plugInResult) HIDReportErrorNum ("CouldnŐt query HID class device interface from plugInInterface", plugInResult); (*ppPlugInInterface)->Release (ppPlugInInterface); } else HIDReportErrorNum ("Failed to create **plugInInterface via IOCreatePlugInInterfaceForService.", result); } if (NULL != pDevice->interface) { result = (*(pDevice->interface))->open (pDevice->interface, 0); if (kIOReturnSuccess != result) HIDReportErrorNum ("Failed to open pDevice->interface via open.", result); else (*(pDevice->interface))->setRemovalCallback (pDevice->interface, HIDRemovalCallback, pDevice, pDevice); } return result; } /* Closes and releases interface to device, should be done prior to exting application * Note: will have no affect if device or interface do not exist * application will "own" the device if interface is not closed * (device may have to be plug and re-plugged in different location to get it working again without a restart) */ static IOReturn HIDCloseReleaseInterface (recDevice *pDevice) { IOReturn result = kIOReturnSuccess; if ((NULL != pDevice) && (NULL != pDevice->interface)) { /* close the interface */ result = (*(pDevice->interface))->close (pDevice->interface); if (kIOReturnNotOpen == result) { /* do nothing as device was not opened, thus can't be closed */ } else if (kIOReturnSuccess != result) HIDReportErrorNum ("Failed to close IOHIDDeviceInterface.", result); /* release the interface */ result = (*(pDevice->interface))->Release (pDevice->interface); if (kIOReturnSuccess != result) HIDReportErrorNum ("Failed to release IOHIDDeviceInterface.", result); pDevice->interface = NULL; } return result; } /* extracts actual specific element information from each element CF dictionary entry */ static void HIDGetElementInfo (CFTypeRef refElement, recElement *pElement) { long number; CFTypeRef refType; refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementCookieKey)); if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number)) pElement->cookie = (IOHIDElementCookie) number; refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementMinKey)); if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number)) pElement->minReport = pElement->min = number; refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementMaxKey)); if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number)) pElement->maxReport = pElement->max = number; /* TODO: maybe should handle the following stuff somehow? refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementScaledMinKey)); if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number)) pElement->scaledMin = number; refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementScaledMaxKey)); if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number)) pElement->scaledMax = number; refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementSizeKey)); if (refType && CFNumberGetValue (refType, kCFNumberLongType, &number)) pElement->size = number; refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementIsRelativeKey)); if (refType) pElement->relative = CFBooleanGetValue (refType); refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementIsWrappingKey)); if (refType) pElement->wrapping = CFBooleanGetValue (refType); refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementIsNonLinearKey)); if (refType) pElement->nonLinear = CFBooleanGetValue (refType); refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementHasPreferedStateKey)); if (refType) pElement->preferredState = CFBooleanGetValue (refType); refType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementHasNullStateKey)); if (refType) pElement->nullState = CFBooleanGetValue (refType); */ } /* examines CF dictionary vlaue in device element hierarchy to determine if it is element of interest or a collection of more elements * if element of interest allocate storage, add to list and retrieve element specific info * if collection then pass on to deconstruction collection into additional individual elements */ static void HIDAddElement (CFTypeRef refElement, recDevice* pDevice) { recElement* element = NULL; recElement** headElement = NULL; long elementType, usagePage, usage; CFTypeRef refElementType = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementTypeKey)); CFTypeRef refUsagePage = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementUsagePageKey)); CFTypeRef refUsage = CFDictionaryGetValue (refElement, CFSTR(kIOHIDElementUsageKey)); if ((refElementType) && (CFNumberGetValue (refElementType, kCFNumberLongType, &elementType))) { /* look at types of interest */ if ((elementType == kIOHIDElementTypeInput_Misc) || (elementType == kIOHIDElementTypeInput_Button) || (elementType == kIOHIDElementTypeInput_Axis)) { if (refUsagePage && CFNumberGetValue (refUsagePage, kCFNumberLongType, &usagePage) && refUsage && CFNumberGetValue (refUsage, kCFNumberLongType, &usage)) { switch (usagePage) /* only interested in kHIDPage_GenericDesktop and kHIDPage_Button */ { case kHIDPage_GenericDesktop: { switch (usage) /* look at usage to determine function */ { case kHIDUsage_GD_X: case kHIDUsage_GD_Y: case kHIDUsage_GD_Z: case kHIDUsage_GD_Rx: case kHIDUsage_GD_Ry: case kHIDUsage_GD_Rz: case kHIDUsage_GD_Slider: case kHIDUsage_GD_Dial: case kHIDUsage_GD_Wheel: element = (recElement *) NewPtrClear (sizeof (recElement)); if (element) { pDevice->axes++; headElement = &(pDevice->firstAxis); } break; case kHIDUsage_GD_Hatswitch: element = (recElement *) NewPtrClear (sizeof (recElement)); if (element) { pDevice->hats++; headElement = &(pDevice->firstHat); } break; } } break; case kHIDPage_Button: element = (recElement *) NewPtrClear (sizeof (recElement)); if (element) { pDevice->buttons++; headElement = &(pDevice->firstButton); } break; default: break; } } } else if (kIOHIDElementTypeCollection == elementType) HIDGetCollectionElements ((CFMutableDictionaryRef) refElement, pDevice); } if (element && headElement) /* add to list */ { pDevice->elements++; if (NULL == *headElement) *headElement = element; else { recElement *elementPrevious, *elementCurrent; elementCurrent = *headElement; while (elementCurrent) { elementPrevious = elementCurrent; elementCurrent = elementPrevious->pNext; } elementPrevious->pNext = element; } element->pNext = NULL; HIDGetElementInfo (refElement, element); } } /* collects information from each array member in device element list (each array memeber = element) */ static void HIDGetElementsCFArrayHandler (const void * value, void * parameter) { if (CFGetTypeID (value) == CFDictionaryGetTypeID ()) HIDAddElement ((CFTypeRef) value, (recDevice *) parameter); } /* handles retrieval of element information from arrays of elements in device IO registry information */ static void HIDGetElements (CFTypeRef refElementCurrent, recDevice *pDevice) { CFTypeID type = CFGetTypeID (refElementCurrent); if (type == CFArrayGetTypeID()) /* if element is an array */ { CFRange range = {0, CFArrayGetCount (refElementCurrent)}; /* CountElementsCFArrayHandler called for each array member */ CFArrayApplyFunction (refElementCurrent, range, HIDGetElementsCFArrayHandler, pDevice); } } /* handles extracting element information from element collection CF types * used from top level element decoding and hierarchy deconstruction to flatten device element list */ static void HIDGetCollectionElements (CFMutableDictionaryRef deviceProperties, recDevice *pDevice) { CFTypeRef refElementTop = CFDictionaryGetValue (deviceProperties, CFSTR(kIOHIDElementKey)); if (refElementTop) HIDGetElements (refElementTop, pDevice); } /* use top level element usage page and usage to discern device usage page and usage setting appropriate vlaues in device record */ static void HIDTopLevelElementHandler (const void * value, void * parameter) { CFTypeRef refCF = 0; if (CFGetTypeID (value) != CFDictionaryGetTypeID ()) return; refCF = CFDictionaryGetValue (value, CFSTR(kIOHIDElementUsagePageKey)); if (!CFNumberGetValue (refCF, kCFNumberLongType, &((recDevice *) parameter)->usagePage)) SDL_SetError ("CFNumberGetValue error retrieving pDevice->usagePage."); refCF = CFDictionaryGetValue (value, CFSTR(kIOHIDElementUsageKey)); if (!CFNumberGetValue (refCF, kCFNumberLongType, &((recDevice *) parameter)->usage)) SDL_SetError ("CFNumberGetValue error retrieving pDevice->usage."); } /* extracts device info from CF dictionary records in IO registry */ static void HIDGetDeviceInfo (io_object_t hidDevice, CFMutableDictionaryRef hidProperties, recDevice *pDevice) { CFMutableDictionaryRef usbProperties = 0; io_registry_entry_t parent1, parent2; /* Mac OS X currently is not mirroring all USB properties to HID page so need to look at USB device page also * get dictionary for usb properties: step up two levels and get CF dictionary for USB properties */ if ((KERN_SUCCESS == IORegistryEntryGetParentEntry (hidDevice, kIOServicePlane, &parent1)) && (KERN_SUCCESS == IORegistryEntryGetParentEntry (parent1, kIOServicePlane, &parent2)) && (KERN_SUCCESS == IORegistryEntryCreateCFProperties (parent2, &usbProperties, kCFAllocatorDefault, kNilOptions))) { if (usbProperties) { CFTypeRef refCF = 0; /* get device info * try hid dictionary first, if fail then go to usb dictionary */ /* get product name */ refCF = CFDictionaryGetValue (hidProperties, CFSTR(kIOHIDProductKey)); if (!refCF) refCF = CFDictionaryGetValue (usbProperties, CFSTR("USB Product Name")); if (refCF) { if (!CFStringGetCString (refCF, pDevice->product, 256, CFStringGetSystemEncoding ())) SDL_SetError ("CFStringGetCString error retrieving pDevice->product."); } /* get usage page and usage */ refCF = CFDictionaryGetValue (hidProperties, CFSTR(kIOHIDPrimaryUsagePageKey)); if (refCF) { if (!CFNumberGetValue (refCF, kCFNumberLongType, &pDevice->usagePage)) SDL_SetError ("CFNumberGetValue error retrieving pDevice->usagePage."); refCF = CFDictionaryGetValue (hidProperties, CFSTR(kIOHIDPrimaryUsageKey)); if (refCF) if (!CFNumberGetValue (refCF, kCFNumberLongType, &pDevice->usage)) SDL_SetError ("CFNumberGetValue error retrieving pDevice->usage."); } if (NULL == refCF) /* get top level element HID usage page or usage */ { /* use top level element instead */ CFTypeRef refCFTopElement = 0; refCFTopElement = CFDictionaryGetValue (hidProperties, CFSTR(kIOHIDElementKey)); { /* refCFTopElement points to an array of element dictionaries */ CFRange range = {0, CFArrayGetCount (refCFTopElement)}; CFArrayApplyFunction (refCFTopElement, range, HIDTopLevelElementHandler, pDevice); } } CFRelease (usbProperties); } else SDL_SetError ("IORegistryEntryCreateCFProperties failed to create usbProperties."); if (kIOReturnSuccess != IOObjectRelease (parent2)) SDL_SetError ("IOObjectRelease error with parent2."); if (kIOReturnSuccess != IOObjectRelease (parent1)) SDL_SetError ("IOObjectRelease error with parent1."); } } static recDevice *HIDBuildDevice (io_object_t hidDevice) { recDevice *pDevice = (recDevice *) NewPtrClear (sizeof (recDevice)); if (pDevice) { /* get dictionary for HID properties */ CFMutableDictionaryRef hidProperties = 0; kern_return_t result = IORegistryEntryCreateCFProperties (hidDevice, &hidProperties, kCFAllocatorDefault, kNilOptions); if ((result == KERN_SUCCESS) && hidProperties) { /* create device interface */ result = HIDCreateOpenDeviceInterface (hidDevice, pDevice); if (kIOReturnSuccess == result) { HIDGetDeviceInfo (hidDevice, hidProperties, pDevice); /* hidDevice used to find parents in registry tree */ HIDGetCollectionElements (hidProperties, pDevice); } else { DisposePtr((Ptr)pDevice); pDevice = NULL; } CFRelease (hidProperties); } else { DisposePtr((Ptr)pDevice); pDevice = NULL; } } return pDevice; } /* disposes of the element list associated with a device and the memory associated with the list */ static void HIDDisposeElementList (recElement **elementList) { recElement *pElement = *elementList; while (pElement) { recElement *pElementNext = pElement->pNext; DisposePtr ((Ptr) pElement); pElement = pElementNext; } *elementList = NULL; } /* disposes of a single device, closing and releaseing interface, freeing memory fro device and elements, setting device pointer to NULL * all your device no longer belong to us... (i.e., you do not 'own' the device anymore) */ static recDevice *HIDDisposeDevice (recDevice **ppDevice) { kern_return_t result = KERN_SUCCESS; recDevice *pDeviceNext = NULL; if (*ppDevice) { /* save next device prior to disposing of this device */ pDeviceNext = (*ppDevice)->pNext; /* free element lists */ HIDDisposeElementList (&(*ppDevice)->firstAxis); HIDDisposeElementList (&(*ppDevice)->firstButton); HIDDisposeElementList (&(*ppDevice)->firstHat); result = HIDCloseReleaseInterface (*ppDevice); /* function sanity checks interface value (now application does not own device) */ if (kIOReturnSuccess != result) HIDReportErrorNum ("HIDCloseReleaseInterface failed when trying to dipose device.", result); DisposePtr ((Ptr)*ppDevice); *ppDevice = NULL; } return pDeviceNext; } /* Function to scan the system for joysticks. * Joystick 0 should be the system default joystick. * This function should return the number of available joysticks, or -1 * on an unrecoverable fatal error. */ int SDL_SYS_JoystickInit(void) { IOReturn result = kIOReturnSuccess; mach_port_t masterPort = 0; io_iterator_t hidObjectIterator = 0; CFMutableDictionaryRef hidMatchDictionary = NULL; recDevice *device, *lastDevice; io_object_t ioHIDDeviceObject = 0; SDL_numjoysticks = 0; if (gpDeviceList) { SDL_SetError("Joystick: Device list already inited."); return -1; } result = IOMasterPort (bootstrap_port, &masterPort); if (kIOReturnSuccess != result) { SDL_SetError("Joystick: IOMasterPort error with bootstrap_port."); return -1; } /* Set up a matching dictionary to search I/O Registry by class name for all HID class devices. */ hidMatchDictionary = IOServiceMatching (kIOHIDDeviceKey); if (hidMatchDictionary) { /* Add key for device type (joystick, in this case) to refine the matching dictionary. */ /* NOTE: we now perform this filtering later UInt32 usagePage = kHIDPage_GenericDesktop; UInt32 usage = kHIDUsage_GD_Joystick; CFNumberRef refUsage = NULL, refUsagePage = NULL; refUsage = CFNumberCreate (kCFAllocatorDefault, kCFNumberIntType, &usage); CFDictionarySetValue (hidMatchDictionary, CFSTR (kIOHIDPrimaryUsageKey), refUsage); refUsagePage = CFNumberCreate (kCFAllocatorDefault, kCFNumberIntType, &usagePage); CFDictionarySetValue (hidMatchDictionary, CFSTR (kIOHIDPrimaryUsagePageKey), refUsagePage); */ } else { SDL_SetError("Joystick: Failed to get HID CFMutableDictionaryRef via IOServiceMatching."); return -1; } /*/ Now search I/O Registry for matching devices. */ result = IOServiceGetMatchingServices (masterPort, hidMatchDictionary, &hidObjectIterator); /* Check for errors */ if (kIOReturnSuccess != result) { SDL_SetError("Joystick: Couldn't create a HID object iterator."); return -1; } if (!hidObjectIterator) /* there are no joysticks */ { gpDeviceList = NULL; SDL_numjoysticks = 0; return 0; } /* IOServiceGetMatchingServices consumes a reference to the dictionary, so we don't need to release the dictionary ref. */ /* build flat linked list of devices from device iterator */ gpDeviceList = lastDevice = NULL; while ((ioHIDDeviceObject = IOIteratorNext (hidObjectIterator))) { /* build a device record */ device = HIDBuildDevice (ioHIDDeviceObject); if (!device) continue; /* dump device object, it is no longer needed */ result = IOObjectRelease (ioHIDDeviceObject); /* if (KERN_SUCCESS != result) HIDReportErrorNum ("IOObjectRelease error with ioHIDDeviceObject.", result); */ /* Filter device list to non-keyboard/mouse stuff */ if ( (device->usagePage != kHIDPage_GenericDesktop) || ((device->usage != kHIDUsage_GD_Joystick && device->usage != kHIDUsage_GD_GamePad && device->usage != kHIDUsage_GD_MultiAxisController)) ) { /* release memory for the device */ HIDDisposeDevice (&device); DisposePtr((Ptr)device); continue; } /* Add device to the end of the list */ if (lastDevice) lastDevice->pNext = device; else gpDeviceList = device; lastDevice = device; } result = IOObjectRelease (hidObjectIterator); /* release the iterator */ /* Count the total number of devices we found */ device = gpDeviceList; while (device) { SDL_numjoysticks++; device = device->pNext; } return SDL_numjoysticks; } /* Function to get the device-dependent name of a joystick */ const char *SDL_SYS_JoystickName(int index) { recDevice *device = gpDeviceList; for (; index > 0; index--) device = device->pNext; return device->product; } /* Function to open a joystick for use. * The joystick to open is specified by the index field of the joystick. * This should fill the nbuttons and naxes fields of the joystick structure. * It returns 0, or -1 if there is an error. */ int SDL_SYS_JoystickOpen(SDL_Joystick *joystick) { recDevice *device = gpDeviceList; int index; for (index = joystick->index; index > 0; index--) device = device->pNext; joystick->hwdata = device; joystick->name = device->product; joystick->naxes = device->axes; joystick->nhats = device->hats; joystick->nballs = 0; joystick->nbuttons = device->buttons; return 0; } /* Function to update the state of a joystick - called as a device poll. * This function shouldn't update the joystick structure directly, * but instead should call SDL_PrivateJoystick*() to deliver events * and update joystick device state. */ void SDL_SYS_JoystickUpdate(SDL_Joystick *joystick) { recDevice *device = joystick->hwdata; recElement *element; SInt32 value, range; int i; if (device->removed) /* device was unplugged; ignore it. */ { if (device->uncentered) { device->uncentered = 0; /* Tell the app that everything is centered/unpressed... */ for (i = 0; i < device->axes; i++) SDL_PrivateJoystickAxis(joystick, i, 0); for (i = 0; i < device->buttons; i++) SDL_PrivateJoystickButton(joystick, i, 0); for (i = 0; i < device->hats; i++) SDL_PrivateJoystickHat(joystick, i, SDL_HAT_CENTERED); } return; } element = device->firstAxis; i = 0; while (element) { value = HIDScaledCalibratedValue(device, element, -32768, 32767); if ( value != joystick->axes[i] ) SDL_PrivateJoystickAxis(joystick, i, value); element = element->pNext; ++i; } element = device->firstButton; i = 0; while (element) { value = HIDGetElementValue(device, element); if (value > 1) /* handle pressure-sensitive buttons */ value = 1; if ( value != joystick->buttons[i] ) SDL_PrivateJoystickButton(joystick, i, value); element = element->pNext; ++i; } element = device->firstHat; i = 0; while (element) { Uint8 pos = 0; range = (element->max - element->min + 1); value = HIDGetElementValue(device, element) - element->min; if (range == 4) /* 4 position hatswitch - scale up value */ value *= 2; else if (range != 8) /* Neither a 4 nor 8 positions - fall back to default position (centered) */ value = -1; switch(value) { case 0: pos = SDL_HAT_UP; break; case 1: pos = SDL_HAT_RIGHTUP; break; case 2: pos = SDL_HAT_RIGHT; break; case 3: pos = SDL_HAT_RIGHTDOWN; break; case 4: pos = SDL_HAT_DOWN; break; case 5: pos = SDL_HAT_LEFTDOWN; break; case 6: pos = SDL_HAT_LEFT; break; case 7: pos = SDL_HAT_LEFTUP; break; default: /* Every other value is mapped to center. We do that because some * joysticks use 8 and some 15 for this value, and apparently * there are even more variants out there - so we try to be generous. */ pos = SDL_HAT_CENTERED; break; } if ( pos != joystick->hats[i] ) SDL_PrivateJoystickHat(joystick, i, pos); element = element->pNext; ++i; } return; } /* Function to close a joystick after use */ void SDL_SYS_JoystickClose(SDL_Joystick *joystick) { /* Should we do anything here? */ return; } /* Function to perform any system-specific joystick related cleanup */ void SDL_SYS_JoystickQuit(void) { while (NULL != gpDeviceList) gpDeviceList = HIDDisposeDevice (&gpDeviceList); } #endif /* SDL_JOYSTICK_IOKIT */