From 6a632eb23c16592ef4a2dcc8230cbb0e4b724cd7 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Wed, 25 Jun 2014 00:20:21 -0700 Subject: [PATCH] Fixed bug 2603 - iOS: update joystick accelerometer code to use CoreMotion 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. --- Xcode-iOS/SDL/SDL.xcodeproj/project.pbxproj | 8 - include/SDL_config_iphoneos.h | 2 +- premake/README-ios.txt | 3 +- .../iphoneos/SDLUIAccelerationDelegate.h | 44 ------ .../iphoneos/SDLUIAccelerationDelegate.m | 141 ------------------ src/joystick/iphoneos/SDL_sysjoystick.m | 86 ++++++++--- 6 files changed, 67 insertions(+), 217 deletions(-) delete mode 100644 src/joystick/iphoneos/SDLUIAccelerationDelegate.h delete mode 100644 src/joystick/iphoneos/SDLUIAccelerationDelegate.m diff --git a/Xcode-iOS/SDL/SDL.xcodeproj/project.pbxproj b/Xcode-iOS/SDL/SDL.xcodeproj/project.pbxproj index 034aa93260d41..0a02ab6ad5f27 100755 --- 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 = ""; }; 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 = ""; }; - FD689F010E26E5B600F90B21 /* SDLUIAccelerationDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDLUIAccelerationDelegate.h; sourceTree = ""; }; - FD689F020E26E5B600F90B21 /* SDLUIAccelerationDelegate.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDLUIAccelerationDelegate.m; sourceTree = ""; }; FD689F0C0E26E5D900F90B21 /* SDL_uikitevents.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDL_uikitevents.h; sourceTree = ""; }; FD689F0D0E26E5D900F90B21 /* SDL_uikitevents.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SDL_uikitevents.m; sourceTree = ""; }; FD689F0E0E26E5D900F90B21 /* SDL_uikitopengles.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SDL_uikitopengles.h; sourceTree = ""; }; @@ -639,8 +635,6 @@ isa = PBXGroup; children = ( FD689F000E26E5B600F90B21 /* SDL_sysjoystick.m */, - FD689F010E26E5B600F90B21 /* SDLUIAccelerationDelegate.h */, - FD689F020E26E5B600F90B21 /* SDLUIAccelerationDelegate.m */, ); path = iphoneos; sourceTree = ""; @@ -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 index 7ffb1c55bea5c..11fd722ffe824 100644 --- 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 index cb491036dde10..75510c046fcea 100755 --- 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. \ No newline at end of file +and binaries. diff --git a/src/joystick/iphoneos/SDLUIAccelerationDelegate.h b/src/joystick/iphoneos/SDLUIAccelerationDelegate.h deleted file mode 100644 index bb3e0d61f95f4..0000000000000 --- a/src/joystick/iphoneos/SDLUIAccelerationDelegate.h +++ /dev/null @@ -1,44 +0,0 @@ -/* - Simple DirectMedia Layer - Copyright (C) 1997-2014 Sam Lantinga - - This software is provided 'as-is', without any express or implied - warranty. In no event will the authors be held liable for any damages - arising from the use of this software. - - Permission is granted to anyone to use this software for any purpose, - including commercial applications, and to alter it and redistribute it - freely, subject to the following restrictions: - - 1. The origin of this software must not be misrepresented; you must not - claim that you wrote the original software. If you use this software - in a product, an acknowledgment in the product documentation would be - appreciated but is not required. - 2. Altered source versions must be plainly marked as such, and must not be - misrepresented as being the original software. - 3. This notice may not be removed or altered from any source distribution. -*/ - -#import -#import - -/* *INDENT-OFF* */ -@interface SDLUIAccelerationDelegate: NSObject { - - UIAccelerationValue x, y, z; - BOOL isRunning; - BOOL hasNewData; - -} - -+(SDLUIAccelerationDelegate *)sharedDelegate; --(void)accelerometer:(UIAccelerometer *)accelerometer didAccelerate:(UIAcceleration *)acceleration; --(void)getLastOrientation:(Sint16 *)data; --(void)startup; --(void)shutdown; --(BOOL)isRunning; --(BOOL)hasNewData; --(void)setHasNewData:(BOOL)value; - -@end -/* *INDENT-ON* */ diff --git a/src/joystick/iphoneos/SDLUIAccelerationDelegate.m b/src/joystick/iphoneos/SDLUIAccelerationDelegate.m deleted file mode 100644 index a099fcf3817ab..0000000000000 --- a/src/joystick/iphoneos/SDLUIAccelerationDelegate.m +++ /dev/null @@ -1,141 +0,0 @@ -/* - Simple DirectMedia Layer - Copyright (C) 1997-2014 Sam Lantinga - - This software is provided 'as-is', without any express or implied - warranty. In no event will the authors be held liable for any damages - arising from the use of this software. - - Permission is granted to anyone to use this software for any purpose, - including commercial applications, and to alter it and redistribute it - freely, subject to the following restrictions: - - 1. The origin of this software must not be misrepresented; you must not - claim that you wrote the original software. If you use this software - in a product, an acknowledgment in the product documentation would be - appreciated but is not required. - 2. Altered source versions must be plainly marked as such, and must not be - misrepresented as being the original software. - 3. This notice may not be removed or altered from any source distribution. -*/ - -#import "SDLUIAccelerationDelegate.h" -/* needed for SDL_IPHONE_MAX_GFORCE macro */ -#import "../../../include/SDL_config_iphoneos.h" - -static SDLUIAccelerationDelegate *sharedDelegate=nil; - -@implementation SDLUIAccelerationDelegate - -/* - Returns a shared instance of the SDLUIAccelerationDelegate, creating the shared delegate if it doesn't exist yet. -*/ -+(SDLUIAccelerationDelegate *)sharedDelegate { - if (sharedDelegate == nil) { - sharedDelegate = [[SDLUIAccelerationDelegate alloc] init]; - } - return sharedDelegate; -} -/* - UIAccelerometerDelegate delegate method. Invoked by the UIAccelerometer instance when it has new data for us. - We just take the data and mark that we have new data available so that the joystick system will pump it to the - events system when SDL_SYS_JoystickUpdate is called. -*/ --(void)accelerometer:(UIAccelerometer *)accelerometer didAccelerate:(UIAcceleration *)acceleration { - - x = acceleration.x; - y = acceleration.y; - z = acceleration.z; - - hasNewData = YES; -} -/* - getLastOrientation -- put last obtained accelerometer data into Sint16 array - - Called from the joystick system when it needs the accelerometer data. - Function grabs the last data sent to the accelerometer and converts it - 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. - */ --(void)getLastOrientation:(Sint16 *)data { - - #define MAX_SINT16 0x7FFF - - /* clamp the data */ - if (x > SDL_IPHONE_MAX_GFORCE) x = SDL_IPHONE_MAX_GFORCE; - else if (x < -SDL_IPHONE_MAX_GFORCE) x = -SDL_IPHONE_MAX_GFORCE; - if (y > SDL_IPHONE_MAX_GFORCE) y = SDL_IPHONE_MAX_GFORCE; - else if (y < -SDL_IPHONE_MAX_GFORCE) y = -SDL_IPHONE_MAX_GFORCE; - if (z > SDL_IPHONE_MAX_GFORCE) z = SDL_IPHONE_MAX_GFORCE; - else if (z < -SDL_IPHONE_MAX_GFORCE) z = -SDL_IPHONE_MAX_GFORCE; - - /* pass in data mapped to range of SInt16 */ - data[0] = (x / SDL_IPHONE_MAX_GFORCE) * MAX_SINT16; - data[1] = (y / SDL_IPHONE_MAX_GFORCE) * MAX_SINT16; - data[2] = (z / SDL_IPHONE_MAX_GFORCE) * MAX_SINT16; - -} - -/* - Initialize SDLUIAccelerationDelegate. Since we don't have any data yet, - just set our last received data to zero, and indicate we don't have any; -*/ --(id)init { - self = [super init]; - x = y = z = 0.0; - hasNewData = NO; - return self; -} - --(void)dealloc { - sharedDelegate = nil; - [self shutdown]; - [super dealloc]; -} - -/* - Lets our delegate start receiving accelerometer updates. -*/ --(void)startup { - [UIAccelerometer sharedAccelerometer].delegate = self; - isRunning = YES; -} -/* - Stops our delegate from receiving accelerometer updates. -*/ --(void)shutdown { - if ([UIAccelerometer sharedAccelerometer].delegate == self) { - [UIAccelerometer sharedAccelerometer].delegate = nil; - } - isRunning = NO; -} -/* - Our we currently receiving accelerometer updates? -*/ --(BOOL)isRunning { - return isRunning; -} -/* - Do we have any data that hasn't been pumped into SDL's event system? -*/ --(BOOL)hasNewData { - return hasNewData; -} -/* - When the joystick system grabs the new data, it sets this to NO. -*/ --(void)setHasNewData:(BOOL)value { - hasNewData = value; -} - -@end diff --git a/src/joystick/iphoneos/SDL_sysjoystick.m b/src/joystick/iphoneos/SDL_sysjoystick.m index a895130a5d5fa..a4027599e755d 100644 --- 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 + +/* 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 )