diff options
Diffstat (limited to 'osdep/ar/HIDRemote.h')
| -rw-r--r-- | osdep/ar/HIDRemote.h | 280 |
1 files changed, 140 insertions, 140 deletions
diff --git a/osdep/ar/HIDRemote.h b/osdep/ar/HIDRemote.h index 9dd16faa5a..33f59f322d 100644 --- a/osdep/ar/HIDRemote.h +++ b/osdep/ar/HIDRemote.h @@ -73,78 +73,78 @@ typedef enum { - kHIDRemoteModeNone = 0L, - kHIDRemoteModeShared, // Share the remote with others - let's you listen to the remote control events as long as noone has an exclusive lock on it - // (RECOMMENDED ONLY FOR SPECIAL PURPOSES) + kHIDRemoteModeNone = 0L, + kHIDRemoteModeShared, // Share the remote with others - let's you listen to the remote control events as long as noone has an exclusive lock on it + // (RECOMMENDED ONLY FOR SPECIAL PURPOSES) - kHIDRemoteModeExclusive, // Try to acquire an exclusive lock on the remote (NOT RECOMMENDED) + kHIDRemoteModeExclusive, // Try to acquire an exclusive lock on the remote (NOT RECOMMENDED) - kHIDRemoteModeExclusiveAuto // Try to acquire an exclusive lock on the remote whenever the application has focus. Temporarily release control over the - // remote when another application has focus (RECOMMENDED) + kHIDRemoteModeExclusiveAuto // Try to acquire an exclusive lock on the remote whenever the application has focus. Temporarily release control over the + // remote when another application has focus (RECOMMENDED) } HIDRemoteMode; typedef enum { - /* A code reserved for "no button" (needed for tracking) */ - kHIDRemoteButtonCodeNone = 0L, - - /* Standard codes - available for white plastic and aluminum remote */ - kHIDRemoteButtonCodeUp, - kHIDRemoteButtonCodeDown, - kHIDRemoteButtonCodeLeft, - kHIDRemoteButtonCodeRight, - kHIDRemoteButtonCodeCenter, - kHIDRemoteButtonCodeMenu, - - /* Extra codes - Only available for the new aluminum version of the remote */ - kHIDRemoteButtonCodePlay, - - /* Masks */ - kHIDRemoteButtonCodeCodeMask = 0xFFL, - kHIDRemoteButtonCodeHoldMask = (1L << 16L), - kHIDRemoteButtonCodeSpecialMask = (1L << 17L), - kHIDRemoteButtonCodeAluminumMask = (1L << 21L), // PRIVATE - only used internally - - /* Hold button standard codes - available for white plastic and aluminum remote */ - kHIDRemoteButtonCodeUpHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodeUp), - kHIDRemoteButtonCodeDownHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodeDown), - kHIDRemoteButtonCodeLeftHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodeLeft), - kHIDRemoteButtonCodeRightHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodeRight), - kHIDRemoteButtonCodeCenterHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodeCenter), - kHIDRemoteButtonCodeMenuHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodeMenu), - - /* Hold button extra codes - Only available for aluminum version of the remote */ - kHIDRemoteButtonCodePlayHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodePlay), - - /* DEPRECATED codes - compatibility with HIDRemote 1.0 */ - kHIDRemoteButtonCodePlus = kHIDRemoteButtonCodeUp, - kHIDRemoteButtonCodePlusHold = kHIDRemoteButtonCodeUpHold, - kHIDRemoteButtonCodeMinus = kHIDRemoteButtonCodeDown, - kHIDRemoteButtonCodeMinusHold = kHIDRemoteButtonCodeDownHold, - kHIDRemoteButtonCodePlayPause = kHIDRemoteButtonCodeCenter, - kHIDRemoteButtonCodePlayPauseHold = kHIDRemoteButtonCodeCenterHold, - - /* Special purpose codes */ - kHIDRemoteButtonCodeIDChanged = (kHIDRemoteButtonCodeSpecialMask|(1L << 18L)), // (the ID of the connected remote has changed, you can safely ignore this) - #ifdef _HIDREMOTE_EXTENSIONS - #define _HIDREMOTE_EXTENSIONS_SECTION 1 - #include "HIDRemoteAdditions.h" - #undef _HIDREMOTE_EXTENSIONS_SECTION - #endif /* _HIDREMOTE_EXTENSIONS */ + /* A code reserved for "no button" (needed for tracking) */ + kHIDRemoteButtonCodeNone = 0L, + + /* Standard codes - available for white plastic and aluminum remote */ + kHIDRemoteButtonCodeUp, + kHIDRemoteButtonCodeDown, + kHIDRemoteButtonCodeLeft, + kHIDRemoteButtonCodeRight, + kHIDRemoteButtonCodeCenter, + kHIDRemoteButtonCodeMenu, + + /* Extra codes - Only available for the new aluminum version of the remote */ + kHIDRemoteButtonCodePlay, + + /* Masks */ + kHIDRemoteButtonCodeCodeMask = 0xFFL, + kHIDRemoteButtonCodeHoldMask = (1L << 16L), + kHIDRemoteButtonCodeSpecialMask = (1L << 17L), + kHIDRemoteButtonCodeAluminumMask = (1L << 21L), // PRIVATE - only used internally + + /* Hold button standard codes - available for white plastic and aluminum remote */ + kHIDRemoteButtonCodeUpHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodeUp), + kHIDRemoteButtonCodeDownHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodeDown), + kHIDRemoteButtonCodeLeftHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodeLeft), + kHIDRemoteButtonCodeRightHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodeRight), + kHIDRemoteButtonCodeCenterHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodeCenter), + kHIDRemoteButtonCodeMenuHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodeMenu), + + /* Hold button extra codes - Only available for aluminum version of the remote */ + kHIDRemoteButtonCodePlayHold = (kHIDRemoteButtonCodeHoldMask|kHIDRemoteButtonCodePlay), + + /* DEPRECATED codes - compatibility with HIDRemote 1.0 */ + kHIDRemoteButtonCodePlus = kHIDRemoteButtonCodeUp, + kHIDRemoteButtonCodePlusHold = kHIDRemoteButtonCodeUpHold, + kHIDRemoteButtonCodeMinus = kHIDRemoteButtonCodeDown, + kHIDRemoteButtonCodeMinusHold = kHIDRemoteButtonCodeDownHold, + kHIDRemoteButtonCodePlayPause = kHIDRemoteButtonCodeCenter, + kHIDRemoteButtonCodePlayPauseHold = kHIDRemoteButtonCodeCenterHold, + + /* Special purpose codes */ + kHIDRemoteButtonCodeIDChanged = (kHIDRemoteButtonCodeSpecialMask|(1L << 18L)), // (the ID of the connected remote has changed, you can safely ignore this) + #ifdef _HIDREMOTE_EXTENSIONS + #define _HIDREMOTE_EXTENSIONS_SECTION 1 + #include "HIDRemoteAdditions.h" + #undef _HIDREMOTE_EXTENSIONS_SECTION + #endif /* _HIDREMOTE_EXTENSIONS */ } HIDRemoteButtonCode; typedef enum { - kHIDRemoteModelUndetermined = 0L, // Assume a white plastic remote - kHIDRemoteModelWhitePlastic, // Signal *likely* to be coming from a white plastic remote - kHIDRemoteModelAluminum // Signal *definitely* coming from an aluminum remote + kHIDRemoteModelUndetermined = 0L, // Assume a white plastic remote + kHIDRemoteModelWhitePlastic, // Signal *likely* to be coming from a white plastic remote + kHIDRemoteModelAluminum // Signal *definitely* coming from an aluminum remote } HIDRemoteModel; typedef enum { - kHIDRemoteAluminumRemoteSupportLevelNone = 0L, // This system has no support for the Aluminum Remote at all - kHIDRemoteAluminumRemoteSupportLevelEmulation, // This system possibly has support for the Aluminum Remote (via emulation) - kHIDRemoteAluminumRemoteSupportLevelNative // This system has native support for the Aluminum Remote + kHIDRemoteAluminumRemoteSupportLevelNone = 0L, // This system has no support for the Aluminum Remote at all + kHIDRemoteAluminumRemoteSupportLevelEmulation, // This system possibly has support for the Aluminum Remote (via emulation) + kHIDRemoteAluminumRemoteSupportLevelNative // This system has native support for the Aluminum Remote } HIDRemoteAluminumRemoteSupportLevel; @class HIDRemote; @@ -153,46 +153,46 @@ typedef enum @protocol HIDRemoteDelegate // Notification of button events -- (void)hidRemote:(HIDRemote *)hidRemote // The instance of HIDRemote sending this - eventWithButton:(HIDRemoteButtonCode)buttonCode // Event for the button specified by code - isPressed:(BOOL)isPressed // The button was pressed (YES) / released (NO) - fromHardwareWithAttributes:(NSMutableDictionary *)attributes; // Information on the device this event comes from +- (void)hidRemote:(HIDRemote *)hidRemote // The instance of HIDRemote sending this + eventWithButton:(HIDRemoteButtonCode)buttonCode // Event for the button specified by code + isPressed:(BOOL)isPressed // The button was pressed (YES) / released (NO) + fromHardwareWithAttributes:(NSMutableDictionary *)attributes; // Information on the device this event comes from @optional // Notification of ID changes -- (void)hidRemote:(HIDRemote *)hidRemote // Invoked when the user switched to a remote control with a different ID - remoteIDChangedOldID:(SInt32)old - newID:(SInt32)newID - forHardwareWithAttributes:(NSMutableDictionary *)attributes; +- (void)hidRemote:(HIDRemote *)hidRemote // Invoked when the user switched to a remote control with a different ID + remoteIDChangedOldID:(SInt32)old + newID:(SInt32)newID + forHardwareWithAttributes:(NSMutableDictionary *)attributes; // Notification about hardware additions/removals -- (void)hidRemote:(HIDRemote *)hidRemote // Invoked when new hardware was found / added to HIDRemote's pool - foundNewHardwareWithAttributes:(NSMutableDictionary *)attributes; +- (void)hidRemote:(HIDRemote *)hidRemote // Invoked when new hardware was found / added to HIDRemote's pool + foundNewHardwareWithAttributes:(NSMutableDictionary *)attributes; -- (void)hidRemote:(HIDRemote *)hidRemote // Invoked when initialization of new hardware as requested failed - failedNewHardwareWithError:(NSError *)error; +- (void)hidRemote:(HIDRemote *)hidRemote // Invoked when initialization of new hardware as requested failed + failedNewHardwareWithError:(NSError *)error; -- (void)hidRemote:(HIDRemote *)hidRemote // Invoked when hardware was removed from HIDRemote's pool - releasedHardwareWithAttributes:(NSMutableDictionary *)attributes; +- (void)hidRemote:(HIDRemote *)hidRemote // Invoked when hardware was removed from HIDRemote's pool + releasedHardwareWithAttributes:(NSMutableDictionary *)attributes; // ### WARNING: Unless you know VERY PRECISELY what you are doing, do not implement any of the delegate methods below. ### // Matching of newly found receiver hardware -- (BOOL)hidRemote:(HIDRemote *)hidRemote // Invoked when new hardware is inspected - inspectNewHardwareWithService:(io_service_t)service // - prematchResult:(BOOL)prematchResult; // Return YES if HIDRemote should go on with this hardware and try - // to use it, or NO if it should not be persued further. +- (BOOL)hidRemote:(HIDRemote *)hidRemote // Invoked when new hardware is inspected + inspectNewHardwareWithService:(io_service_t)service // + prematchResult:(BOOL)prematchResult; // Return YES if HIDRemote should go on with this hardware and try + // to use it, or NO if it should not be persued further. // Exlusive lock lending - (BOOL)hidRemote:(HIDRemote *)hidRemote - lendExclusiveLockToApplicationWithInfo:(NSDictionary *)applicationInfo; + lendExclusiveLockToApplicationWithInfo:(NSDictionary *)applicationInfo; - (void)hidRemote:(HIDRemote *)hidRemote - exclusiveLockReleasedByApplicationWithInfo:(NSDictionary *)applicationInfo; + exclusiveLockReleasedByApplicationWithInfo:(NSDictionary *)applicationInfo; - (BOOL)hidRemote:(HIDRemote *)hidRemote - shouldRetryExclusiveLockWithInfo:(NSDictionary *)applicationInfo; + shouldRetryExclusiveLockWithInfo:(NSDictionary *)applicationInfo; @end @@ -201,65 +201,65 @@ typedef enum @interface HIDRemote : NSObject { - // IOMasterPort - mach_port_t _masterPort; - - // Notification ports - IONotificationPortRef _notifyPort; - CFRunLoopSourceRef _notifyRLSource; - - // Matching iterator - io_iterator_t _matchingServicesIterator; - - // SecureInput notification - io_object_t _secureInputNotification; - - // Service attributes - NSMutableDictionary *_serviceAttribMap; - - // Mode - HIDRemoteMode _mode; - BOOL _autoRecover; - NSTimer *_autoRecoveryTimer; - - // Delegate - NSObject <HIDRemoteDelegate> *_delegate; - - // Last seen ID and remote model - SInt32 _lastSeenRemoteID; - HIDRemoteModel _lastSeenModel; - SInt32 _lastSeenModelRemoteID; - - // Unused button codes - NSArray *_unusedButtonCodes; - - // Simulate Plus/Minus Hold - BOOL _simulateHoldEvents; - - // SecureEventInput workaround - BOOL _secureEventInputWorkAround; - UInt64 _lastSecureEventInputPIDSum; - uid_t _lastFrontUserSession; - - // Exclusive lock lending - BOOL _exclusiveLockLending; - BOOL _sendExclusiveResourceReuseNotification; - NSNumber *_waitForReturnByPID; - NSNumber *_returnToPID; - BOOL _isRestarting; - - // Status notifications - BOOL _sendStatusNotifications; - NSString *_pidString; - - // Status - BOOL _applicationIsTerminating; - BOOL _isStopping; - - // Thread safety - #ifdef HIDREMOTE_THREADSAFETY_HARDENED_NOTIFICATION_HANDLING /* #define HIDREMOTE_THREADSAFETY_HARDENED_NOTIFICATION_HANDLING if you're running your HIDRemote instance on a background thread (requires OS X 10.5 or later) */ - NSThread *_runOnThread; - #endif + // IOMasterPort + mach_port_t _masterPort; + + // Notification ports + IONotificationPortRef _notifyPort; + CFRunLoopSourceRef _notifyRLSource; + + // Matching iterator + io_iterator_t _matchingServicesIterator; + + // SecureInput notification + io_object_t _secureInputNotification; + + // Service attributes + NSMutableDictionary *_serviceAttribMap; + + // Mode + HIDRemoteMode _mode; + BOOL _autoRecover; + NSTimer *_autoRecoveryTimer; + + // Delegate + NSObject <HIDRemoteDelegate> *_delegate; + + // Last seen ID and remote model + SInt32 _lastSeenRemoteID; + HIDRemoteModel _lastSeenModel; + SInt32 _lastSeenModelRemoteID; + + // Unused button codes + NSArray *_unusedButtonCodes; + + // Simulate Plus/Minus Hold + BOOL _simulateHoldEvents; + + // SecureEventInput workaround + BOOL _secureEventInputWorkAround; + UInt64 _lastSecureEventInputPIDSum; + uid_t _lastFrontUserSession; + + // Exclusive lock lending + BOOL _exclusiveLockLending; + BOOL _sendExclusiveResourceReuseNotification; + NSNumber *_waitForReturnByPID; + NSNumber *_returnToPID; + BOOL _isRestarting; + + // Status notifications + BOOL _sendStatusNotifications; + NSString *_pidString; + + // Status + BOOL _applicationIsTerminating; + BOOL _isStopping; + + // Thread safety + #ifdef HIDREMOTE_THREADSAFETY_HARDENED_NOTIFICATION_HANDLING /* #define HIDREMOTE_THREADSAFETY_HARDENED_NOTIFICATION_HANDLING if you're running your HIDRemote instance on a background thread (requires OS X 10.5 or later) */ + NSThread *_runOnThread; + #endif } #pragma mark -- PUBLIC: Shared HID Remote -- @@ -271,7 +271,7 @@ typedef enum - (HIDRemoteAluminumRemoteSupportLevel)aluminiumRemoteSystemSupportLevel; #pragma mark -- PUBLIC: Interface / API -- -- (BOOL)startRemoteControl:(HIDRemoteMode)hidRemoteMode; +- (BOOL)startRemoteControl:(HIDRemoteMode)hidRemoteMode; - (void)stopRemoteControl; - (BOOL)isStarted; @@ -374,5 +374,5 @@ extern NSString *kHIDRemoteDNStatusActionNoNeed; #pragma mark -- Driver compatibility flags -- typedef enum { - kHIDRemoteCompatibilityFlagsStandardHIDRemoteDevice = 1L, + kHIDRemoteCompatibilityFlagsStandardHIDRemoteDevice = 1L, } HIDRemoteCompatibilityFlags; |