Fixed bug 2603 - iOS: update joystick accelerometer code to use CoreM…

…otion instead of the deprecated UIAccelerometer Alex Szpakowski SDL's code for exposing the accelerometer as a joystick on iOS currently uses UIAccelerometer, which was superseded by the CoreMotion framework and deprecated since iOS 5. The UIAccelerometer code still works (for now), but it also throws deprecation warnings whenever SDL is built for iOS, since SDL's deployment target is no longer below iOS 5. I've created a patch which replaces the old UIAccelerometer code with a replacement based on the CoreMotion framework. It has identical functionality (to SDL users), however iOS apps are now required to link to the CoreMotion framework when using SDL.
libsdl-org · Jun 25, 2014 · 6a632eb · 6a632eb
1 parent 52ec151
commit 6a632eb
Show file tree

Hide file tree

Showing 6 changed files with 67 additions and 217 deletions.
diff --git a/Xcode-iOS/SDL/SDL.xcodeproj/project.pbxproj b/Xcode-iOS/SDL/SDL.xcodeproj/project.pbxproj
@@ -175,8 +175,6 @@
 		FD6526800DE8FCDD002AD96B /* SDL_timer.c in Sources */ = {isa = PBXBuildFile; fileRef = FD99BA2E0DD52EDC00FB1D6B /* SDL_timer.c */; };
 		FD6526810DE8FCDD002AD96B /* SDL_systimer.c in Sources */ = {isa = PBXBuildFile; fileRef = FD99BA310DD52EDC00FB1D6B /* SDL_systimer.c */; };
 		FD689F030E26E5B600F90B21 /* SDL_sysjoystick.m in Sources */ = {isa = PBXBuildFile; fileRef = FD689F000E26E5B600F90B21 /* SDL_sysjoystick.m */; };
-		FD689F040E26E5B600F90B21 /* SDLUIAccelerationDelegate.h in Headers */ = {isa = PBXBuildFile; fileRef = FD689F010E26E5B600F90B21 /* SDLUIAccelerationDelegate.h */; };
-		FD689F050E26E5B600F90B21 /* SDLUIAccelerationDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = FD689F020E26E5B600F90B21 /* SDLUIAccelerationDelegate.m */; };
 		FD689F1C0E26E5D900F90B21 /* SDL_uikitevents.h in Headers */ = {isa = PBXBuildFile; fileRef = FD689F0C0E26E5D900F90B21 /* SDL_uikitevents.h */; };
 		FD689F1D0E26E5D900F90B21 /* SDL_uikitevents.m in Sources */ = {isa = PBXBuildFile; fileRef = FD689F0D0E26E5D900F90B21 /* SDL_uikitevents.m */; };
 		FD689F1E0E26E5D900F90B21 /* SDL_uikitopengles.h in Headers */ = {isa = PBXBuildFile; fileRef = FD689F0E0E26E5D900F90B21 /* SDL_uikitopengles.h */; };
@@ -353,8 +351,6 @@
 		FD5F9D200E0E08B3008E885B /* SDL_sysjoystick.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDL_sysjoystick.h; sourceTree = "<group>"; };
 		FD6526630DE8FCCB002AD96B /* libSDL2.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libSDL2.a; sourceTree = BUILT_PRODUCTS_DIR; };
 		FD689F000E26E5B600F90B21 /* SDL_sysjoystick.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDL_sysjoystick.m; sourceTree = "<group>"; };
-		FD689F010E26E5B600F90B21 /* SDLUIAccelerationDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLUIAccelerationDelegate.h; sourceTree = "<group>"; };
-		FD689F020E26E5B600F90B21 /* SDLUIAccelerationDelegate.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLUIAccelerationDelegate.m; sourceTree = "<group>"; };
 		FD689F0C0E26E5D900F90B21 /* SDL_uikitevents.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDL_uikitevents.h; sourceTree = "<group>"; };
 		FD689F0D0E26E5D900F90B21 /* SDL_uikitevents.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDL_uikitevents.m; sourceTree = "<group>"; };
 		FD689F0E0E26E5D900F90B21 /* SDL_uikitopengles.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDL_uikitopengles.h; sourceTree = "<group>"; };
@@ -639,8 +635,6 @@
 			isa = PBXGroup;
 			children = (
 				FD689F000E26E5B600F90B21 /* SDL_sysjoystick.m */,
-				FD689F010E26E5B600F90B21 /* SDLUIAccelerationDelegate.h */,
-				FD689F020E26E5B600F90B21 /* SDLUIAccelerationDelegate.m */,
 			);
 			path = iphoneos;
 			sourceTree = "<group>";
@@ -972,7 +966,6 @@
 				FDA686000DF244C800F98A1A /* SDL_nullvideo.h in Headers */,
 				FD5F9D300E0E08B3008E885B /* SDL_joystick_c.h in Headers */,
 				FD5F9D310E0E08B3008E885B /* SDL_sysjoystick.h in Headers */,
-				FD689F040E26E5B600F90B21 /* SDLUIAccelerationDelegate.h in Headers */,
 				FD689F1C0E26E5D900F90B21 /* SDL_uikitevents.h in Headers */,
 				FD689F1E0E26E5D900F90B21 /* SDL_uikitopengles.h in Headers */,
 				FD689F200E26E5D900F90B21 /* SDL_uikitvideo.h in Headers */,
@@ -1181,7 +1174,6 @@
 				FDA685FF0DF244C800F98A1A /* SDL_nullvideo.c in Sources */,
 				FD5F9D2F0E0E08B3008E885B /* SDL_joystick.c in Sources */,
 				FD689F030E26E5B600F90B21 /* SDL_sysjoystick.m in Sources */,
-				FD689F050E26E5B600F90B21 /* SDLUIAccelerationDelegate.m in Sources */,
 				FD689F1D0E26E5D900F90B21 /* SDL_uikitevents.m in Sources */,
 				FD689F1F0E26E5D900F90B21 /* SDL_uikitopengles.m in Sources */,
 				FD689F210E26E5D900F90B21 /* SDL_uikitvideo.m in Sources */,

diff --git a/include/SDL_config_iphoneos.h b/include/SDL_config_iphoneos.h
@@ -149,7 +149,7 @@
 #define SDL_JOYSTICK_DISABLED 0
 
 /* Set max recognized G-force from accelerometer
-   See src/joystick/uikit/SDLUIAccelerationDelegate.m for notes on why this is needed
+   See src/joystick/uikit/SDL_sysjoystick.m for notes on why this is needed
  */
 #define SDL_IPHONE_MAX_GFORCE 5.0
 

diff --git a/premake/README-ios.txt b/premake/README-ios.txt
@@ -25,9 +25,10 @@ Xcode-iOS project. Those are:
   -UIKit.framework
   -Foundation.framework
   -CoreAudio.framework
+  -CoreMotion.framework
 
 All of these frameworks are part of the iOS SDK, not part of the core OS X
 system.
 
 Run the clean script to clear out the directory of Xcode-related files
-and binaries.
+and binaries.
diff --git a/src/joystick/iphoneos/SDLUIAccelerationDelegate.h b/src/joystick/iphoneos/SDLUIAccelerationDelegate.h
diff --git a/src/joystick/iphoneos/SDLUIAccelerationDelegate.m b/src/joystick/iphoneos/SDLUIAccelerationDelegate.m
diff --git a/src/joystick/iphoneos/SDL_sysjoystick.m b/src/joystick/iphoneos/SDL_sysjoystick.m
@@ -23,11 +23,18 @@
 /* This is the iOS implementation of the SDL joystick API */
 
 #include "SDL_joystick.h"
+#include "SDL_stdinc.h"
 #include "../SDL_sysjoystick.h"
 #include "../SDL_joystick_c.h"
-#import "SDLUIAccelerationDelegate.h"
 
-const char *accelerometerName = "iPhone accelerometer";
+#import <CoreMotion/CoreMotion.h>
+
+/* needed for SDL_IPHONE_MAX_GFORCE macro */
+#import "SDL_config_iphoneos.h"
+
+const char *accelerometerName = "iOS accelerometer";
+
+static CMMotionManager *motionManager = nil;
 
 /* Function to scan the system for joysticks.
  * This function should set SDL_numjoysticks to the number of available
@@ -74,7 +81,15 @@ SDL_JoystickID SDL_SYS_GetInstanceIdOfDeviceIndex(int device_index)
     joystick->nhats = 0;
     joystick->nballs = 0;
     joystick->nbuttons = 0;
-    [[SDLUIAccelerationDelegate sharedDelegate] startup];
+
+    if (motionManager == nil) {
+        motionManager = [[CMMotionManager alloc] init];
+    }
+
+    /* Shorter times between updates can significantly increase CPU usage. */
+    motionManager.accelerometerUpdateInterval = 0.1;
+    [motionManager startAccelerometerUpdates];
+
     return 0;
 }
 
@@ -84,6 +99,45 @@ SDL_bool SDL_SYS_JoystickAttached(SDL_Joystick *joystick)
     return SDL_TRUE;
 }
 
+static void SDL_SYS_AccelerometerUpdate(SDL_Joystick * joystick)
+{
+    const float maxgforce = SDL_IPHONE_MAX_GFORCE;
+    const SInt16 maxsint16 = 0x7FFF;
+    CMAcceleration accel;
+
+    if (!motionManager.accelerometerActive) {
+        return;
+    }
+
+    accel = [[motionManager accelerometerData] acceleration];
+
+    /*
+     Convert accelerometer data from floating point to Sint16, which is what
+     the joystick system expects.
+
+     To do the conversion, the data is first clamped onto the interval
+     [-SDL_IPHONE_MAX_G_FORCE, SDL_IPHONE_MAX_G_FORCE], then the data is multiplied
+     by MAX_SINT16 so that it is mapped to the full range of an Sint16.
+
+     You can customize the clamped range of this function by modifying the
+     SDL_IPHONE_MAX_GFORCE macro in SDL_config_iphoneos.h.
+
+     Once converted to Sint16, the accelerometer data no longer has coherent
+     units. You can convert the data back to units of g-force by multiplying
+     it in your application's code by SDL_IPHONE_MAX_GFORCE / 0x7FFF.
+     */
+
+    /* clamp the data */
+    accel.x = SDL_min(SDL_max(accel.x, -maxgforce), maxgforce);
+    accel.y = SDL_min(SDL_max(accel.y, -maxgforce), maxgforce);
+    accel.z = SDL_min(SDL_max(accel.z, -maxgforce), maxgforce);
+
+    /* pass in data mapped to range of SInt16 */
+    SDL_PrivateJoystickAxis(joystick, 0, (accel.x / maxgforce) * maxsint16);
+    SDL_PrivateJoystickAxis(joystick, 1, -(accel.y / maxgforce) * maxsint16);
+    SDL_PrivateJoystickAxis(joystick, 2, (accel.z / maxgforce) * maxsint16);
+}
+
 /* 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
@@ -92,37 +146,25 @@ SDL_bool SDL_SYS_JoystickAttached(SDL_Joystick *joystick)
 void
 SDL_SYS_JoystickUpdate(SDL_Joystick * joystick)
 {
-
-    Sint16 orientation[3];
-
-    if ([[SDLUIAccelerationDelegate sharedDelegate] hasNewData]) {
-
-        [[SDLUIAccelerationDelegate sharedDelegate] getLastOrientation: orientation];
-        [[SDLUIAccelerationDelegate sharedDelegate] setHasNewData: NO];
-
-        SDL_PrivateJoystickAxis(joystick, 0, orientation[0]);
-        SDL_PrivateJoystickAxis(joystick, 1, -orientation[1]);
-        SDL_PrivateJoystickAxis(joystick, 2, orientation[2]);
-
-    }
-
-    return;
+    SDL_SYS_AccelerometerUpdate(joystick);
 }
 
 /* Function to close a joystick after use */
 void
 SDL_SYS_JoystickClose(SDL_Joystick * joystick)
 {
-    if ([[SDLUIAccelerationDelegate sharedDelegate] isRunning]) {
-        [[SDLUIAccelerationDelegate sharedDelegate] shutdown];
-    }
-    SDL_SetError("No joystick open with that index");
+    [motionManager stopAccelerometerUpdates];
+    joystick->closed = 1;
 }
 
 /* Function to perform any system-specific joystick related cleanup */
 void
 SDL_SYS_JoystickQuit(void)
 {
+    if (motionManager != nil) {
+        [motionManager release];
+        motionManager = nil;
+    }
 }
 
 SDL_JoystickGUID SDL_SYS_JoystickGetDeviceGUID( int device_index )