From 0b49dcaa2d3f2c629ca1fd9abf84ddea0c164911 Mon Sep 17 00:00:00 2001 From: Jonas Kvinge Date: Sun, 22 Sep 2024 01:12:01 +0200 Subject: [PATCH] Remove 3rdparty/SPMediaKeyTap --- 3rdparty/README.md | 9 - 3rdparty/SPMediaKeyTap/CMakeLists.txt | 11 - 3rdparty/SPMediaKeyTap/LICENSE | 8 - 3rdparty/SPMediaKeyTap/README.md | 12 - 3rdparty/SPMediaKeyTap/SPMediaKeyTap.h | 53 ---- 3rdparty/SPMediaKeyTap/SPMediaKeyTap.m | 361 ------------------------- CMakeLists.txt | 4 +- debian/copyright | 5 - src/CMakeLists.txt | 2 +- src/core/mac_startup.mm | 2 +- 10 files changed, 3 insertions(+), 464 deletions(-) delete mode 100644 3rdparty/SPMediaKeyTap/CMakeLists.txt delete mode 100644 3rdparty/SPMediaKeyTap/LICENSE delete mode 100644 3rdparty/SPMediaKeyTap/README.md delete mode 100644 3rdparty/SPMediaKeyTap/SPMediaKeyTap.h delete mode 100644 3rdparty/SPMediaKeyTap/SPMediaKeyTap.m diff --git a/3rdparty/README.md b/3rdparty/README.md index fa80f031d..a6f1d4510 100644 --- a/3rdparty/README.md +++ b/3rdparty/README.md @@ -11,15 +11,6 @@ This 3rdparty copy is used only if KDSingleApplication 1.1 or higher is not foun URL: https://github.com/KDAB/KDSingleApplication/ -SPMediaKeyTap -------------- -A library used on macOS to exclusively grab global media shortcuts. - -The library is no longer maintained by the original author. - -The directory can safely be deleted on other platforms. - - gstfastspectrum --------------- A GStreamer spectrum plugin using FFTW3. diff --git a/3rdparty/SPMediaKeyTap/CMakeLists.txt b/3rdparty/SPMediaKeyTap/CMakeLists.txt deleted file mode 100644 index cb32df75e..000000000 --- a/3rdparty/SPMediaKeyTap/CMakeLists.txt +++ /dev/null @@ -1,11 +0,0 @@ -set(SPMEDIAKEY-SOURCES - SPMediaKeyTap.m -) - -set(SPMEDIAKEY-HEADERS - SPMediaKeyTap.h -) - -ADD_LIBRARY(SPMediaKeyTap STATIC - ${SPMEDIAKEY-SOURCES} -) diff --git a/3rdparty/SPMediaKeyTap/LICENSE b/3rdparty/SPMediaKeyTap/LICENSE deleted file mode 100644 index a43e4122e..000000000 --- a/3rdparty/SPMediaKeyTap/LICENSE +++ /dev/null @@ -1,8 +0,0 @@ -Copyright (c) 2011, Joachim Bengtsson -All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - -* Neither the name of the organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/3rdparty/SPMediaKeyTap/README.md b/3rdparty/SPMediaKeyTap/README.md deleted file mode 100644 index 171a6045f..000000000 --- a/3rdparty/SPMediaKeyTap/README.md +++ /dev/null @@ -1,12 +0,0 @@ -SPMediaKeyTap -============= - -`SPMediaKeyTap` abstracts a `CGEventHook` and other nastiness in order to give you a relatively simple API to receive media key events (prev/next/playpause, on F7 to F9 on modern MacBook Pros) exclusively, without them reaching other applications like iTunes. `SPMediaKeyTap` is clever enough to resign its exclusive lock on media keys by looking for which application was active most recently: if that application is in `SPMediaKeyTap`'s whitelist, it will resign the keys. This is similar to the behavior of Apple's applications collaborating on media key handling exclusivity, but unfortunately, Apple is not exposing any APIs allowing third-parties to join in on this collaboration. - -For now, the whitelist is just a hardcoded array in `+[SPMediaKeyTap defaultMediaKeyUserBundleIdentifiers]`. If your app starts using `SPMediaKeyTap`, please [mail me](mailto:nevyn@spotify.com) your bundle ID, and I'll include it in the canonical repository. This is a bad solution; a better solution would be to use distributed notifications to collaborate in creating this whitelist at runtime. Hopefully someone'll have the time and energy to write this soon. - -In `Example/SPMediaKeyTapExampleAppDelegate.m` is an example of both how you use `SPMediaKeyTap`, and how you handle the semi-private `NSEvent` subtypes involved in media keys, including on how to fall back to non-event tap handling of these events. - -`SPMediaKeyTap` and other `CGEventHook`s on the event type `NSSystemDefined` is known to interfere with each other and applications doing weird stuff with mouse input, because mouse clicks are also part of the `NSSystemDefined` category. The single issue we have had reported here at Spotify is Adobe Fireworks, in which item selection stops working with `SPMediaKeyTap` is active. - -`SPMediaKeyTap` requires 10.5 to work, and disables itself on 10.4. diff --git a/3rdparty/SPMediaKeyTap/SPMediaKeyTap.h b/3rdparty/SPMediaKeyTap/SPMediaKeyTap.h deleted file mode 100644 index fd437a833..000000000 --- a/3rdparty/SPMediaKeyTap/SPMediaKeyTap.h +++ /dev/null @@ -1,53 +0,0 @@ -/* - Copyright (c) 2011, Joachim Bengtsson - All rights reserved. - - Redistribution and use in source and binary forms, with or without modification, - are permitted provided that the following conditions are met: - - * Neither the name of the organization nor the names of its contributors may - be used to endorse or promote products derived from this software without - specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND - ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED - WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE - DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE - FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR - SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER - CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, - OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -#import -#import - -// http://overooped.com/post/2593597587/mediakeys - -#define SPSystemDefinedEventMediaKeys 8 - -@interface SPMediaKeyTap : NSObject - -- (id)initWithDelegate:(id)delegate; - -+ (BOOL)usesGlobalMediaKeyTap; -- (BOOL)startWatchingMediaKeys; -- (void)stopWatchingMediaKeys; -- (void)handleAndReleaseMediaKeyEvent:(NSEvent *)event; -@end - -@interface NSObject (SPMediaKeyTapDelegate) -- (void)mediaKeyTap:(SPMediaKeyTap*)keyTap receivedMediaKeyEvent:(NSEvent*)event; -@end - -#ifdef __cplusplus -extern "C" { -#endif - -extern NSString *kIgnoreMediaKeysDefaultsKey; - -#ifdef __cplusplus -} -#endif diff --git a/3rdparty/SPMediaKeyTap/SPMediaKeyTap.m b/3rdparty/SPMediaKeyTap/SPMediaKeyTap.m deleted file mode 100644 index 1a1c6ba88..000000000 --- a/3rdparty/SPMediaKeyTap/SPMediaKeyTap.m +++ /dev/null @@ -1,361 +0,0 @@ -/* - Copyright (c) 2011, Joachim Bengtsson - All rights reserved. - - Redistribution and use in source and binary forms, with or without modification, - are permitted provided that the following conditions are met: - - * Neither the name of the organization nor the names of its contributors may - be used to endorse or promote products derived from this software without - specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND - ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED - WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE - DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE - FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR - SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER - CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, - OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -*/ - -// Copyright (c) 2010 Spotify AB -#import "SPMediaKeyTap.h" - -// Define to enable app list debug output -// #define DEBUG_SPMEDIAKEY_APPLIST 1 - -NSString *kIgnoreMediaKeysDefaultsKey = @"SPIgnoreMediaKeys"; - -@interface SPMediaKeyTap () { - CFMachPortRef _eventPort; - CFRunLoopSourceRef _eventPortSource; - CFRunLoopRef _tapThreadRL; - NSThread *_tapThread; - BOOL _shouldInterceptMediaKeyEvents; - id _delegate; - // The app that is frontmost in this list owns media keys - NSMutableArray *_mediaKeyAppList; -} - -- (BOOL)shouldInterceptMediaKeyEvents; -- (void)setShouldInterceptMediaKeyEvents:(BOOL)newSetting; -- (void)startWatchingAppSwitching; -- (void)stopWatchingAppSwitching; -- (void)eventTapThread; -@end - -static CGEventRef tapEventCallback(CGEventTapProxy proxy, CGEventType type, CGEventRef event, void *refcon); - - -// Inspired by http://gist.github.com/546311 - -@implementation SPMediaKeyTap - -#pragma mark - -#pragma mark Setup and teardown - -- (id)initWithDelegate:(id)delegate -{ - self = [super init]; - if (self) { - _delegate = delegate; - [self startWatchingAppSwitching]; - _mediaKeyAppList = [NSMutableArray new]; - } - return self; -} - -- (void)dealloc -{ - [self stopWatchingMediaKeys]; - [self stopWatchingAppSwitching]; - [super dealloc]; -} - -- (void)startWatchingAppSwitching -{ - // Listen to "app switched" event, so that we don't intercept media keys if we - // weren't the last "media key listening" app to be active - - [[[NSWorkspace sharedWorkspace] notificationCenter] addObserver:self - selector:@selector(frontmostAppChanged:) - name:NSWorkspaceDidActivateApplicationNotification - object:nil]; - - - [[[NSWorkspace sharedWorkspace] notificationCenter] addObserver:self - selector:@selector(appTerminated:) - name:NSWorkspaceDidTerminateApplicationNotification - object:nil]; -} - -- (void)stopWatchingAppSwitching -{ - [[[NSWorkspace sharedWorkspace] notificationCenter] removeObserver:self]; -} - -- (BOOL)startWatchingMediaKeys -{ - // Prevent having multiple mediaKeys threads - [self stopWatchingMediaKeys]; - - [self setShouldInterceptMediaKeyEvents:YES]; - - // Add an event tap to intercept the system defined media key events - _eventPort = CGEventTapCreate(kCGSessionEventTap, - kCGHeadInsertEventTap, - kCGEventTapOptionDefault, - CGEventMaskBit(NX_SYSDEFINED), - tapEventCallback, - (__bridge void * __nullable)(self)); - - // Can be NULL if the app has no accessibility access permission - if (_eventPort == NULL) - return NO; - - _eventPortSource = CFMachPortCreateRunLoopSource(kCFAllocatorSystemDefault, _eventPort, 0); - assert(_eventPortSource != NULL); - - if (_eventPortSource == NULL) - return NO; - - // Let's do this in a separate thread so that a slow app doesn't lag the event tap - _tapThread = [[NSThread alloc] initWithTarget:self - selector:@selector(eventTapThread) - object:nil]; - [_tapThread start]; - - return YES; -} - -- (void)stopWatchingMediaKeys -{ - // Shut down tap thread - if(_tapThreadRL){ - CFRunLoopStop(_tapThreadRL); - _tapThreadRL = nil; - } - - // Remove tap port - if(_eventPort){ - CFMachPortInvalidate(_eventPort); - CFRelease(_eventPort); - _eventPort = nil; - } - - // Remove tap source - if(_eventPortSource){ - CFRelease(_eventPortSource); - _eventPortSource = nil; - } -} - -#pragma mark - -#pragma mark Accessors - -+ (BOOL)usesGlobalMediaKeyTap -{ -#ifdef _DEBUG - // breaking in gdb with a key tap inserted sometimes locks up all mouse and keyboard input forever, forcing reboot - return NO; -#else - // XXX(nevyn): MediaKey event tap doesn't work on 10.4, feel free to figure out why if you have the energy. - return - ![[NSUserDefaults standardUserDefaults] boolForKey:kIgnoreMediaKeysDefaultsKey] - && floor(NSAppKitVersionNumber) >= 949/*NSAppKitVersionNumber10_5*/; -#endif -} - -+ (NSArray*)mediaKeyUserBundleIdentifiers -{ - return [NSArray arrayWithObjects: - [[NSBundle mainBundle] bundleIdentifier], // your app - @"com.spotify.client", - @"com.apple.iTunes", - @"com.apple.QuickTimePlayerX", - @"com.apple.quicktimeplayer", - @"com.apple.iWork.Keynote", - @"com.apple.iPhoto", - @"org.videolan.vlc", - @"com.apple.Aperture", - @"com.plexsquared.Plex", - @"com.soundcloud.desktop", - @"org.niltsh.MPlayerX", - @"com.ilabs.PandorasHelper", - @"com.mahasoftware.pandabar", - @"com.bitcartel.pandorajam", - @"org.clementine-player.clementine", - @"fm.last.Last.fm", - @"fm.last.Scrobbler", - @"com.beatport.BeatportPro", - @"com.Timenut.SongKey", - @"com.macromedia.fireworks", // the tap messes up their mouse input - @"at.justp.Theremin", - @"ru.ya.themblsha.YandexMusic", - @"com.jriver.MediaCenter18", - @"com.jriver.MediaCenter19", - @"com.jriver.MediaCenter20", - @"co.rackit.mate", - @"com.ttitt.b-music", - @"com.beardedspice.BeardedSpice", - @"com.plug.Plug", - @"com.plug.Plug2", - @"com.netease.163music", - @"org.quodlibet.quodlibet", - nil - ]; -} - - -- (BOOL)shouldInterceptMediaKeyEvents -{ - BOOL shouldIntercept = NO; - @synchronized(self) { - shouldIntercept = _shouldInterceptMediaKeyEvents; - } - return shouldIntercept; -} - -- (void)pauseTapOnTapThread:(NSNumber *)yeahno -{ - CGEventTapEnable(self->_eventPort, [yeahno boolValue]); -} - -- (void)setShouldInterceptMediaKeyEvents:(BOOL)newSetting -{ - BOOL oldSetting; - @synchronized(self) { - oldSetting = _shouldInterceptMediaKeyEvents; - _shouldInterceptMediaKeyEvents = newSetting; - } - if(_tapThreadRL && oldSetting != newSetting) { - [self performSelector:@selector(pauseTapOnTapThread:) - onThread:_tapThread - withObject:@(newSetting) - waitUntilDone:NO]; - - } -} - - -#pragma mark - -#pragma mark Event tap callbacks - -// Note: method called on background thread - -static CGEventRef tapEventCallback2(CGEventTapProxy proxy, CGEventType type, CGEventRef event, void *refcon) -{ - #pragma unused(proxy) - SPMediaKeyTap *self = (__bridge SPMediaKeyTap *)refcon; - - if(type == kCGEventTapDisabledByTimeout) { - NSLog(@"Media key event tap was disabled by timeout"); - CGEventTapEnable(self->_eventPort, TRUE); - return event; - } else if(type == kCGEventTapDisabledByUserInput) { - // Was disabled manually by -[pauseTapOnTapThread] - return event; - } - NSEvent *nsEvent = nil; - @try { - nsEvent = [NSEvent eventWithCGEvent:event]; - } - @catch (NSException * e) { - NSLog(@"Strange CGEventType: %d: %@", type, e); - assert(0); - return event; - } - - if (type != NX_SYSDEFINED || [nsEvent subtype] != SPSystemDefinedEventMediaKeys) - return event; - - int keyCode = (([nsEvent data1] & 0xFFFF0000) >> 16); - if (keyCode != NX_KEYTYPE_PLAY && keyCode != NX_KEYTYPE_FAST && keyCode != NX_KEYTYPE_REWIND && keyCode != NX_KEYTYPE_PREVIOUS && keyCode != NX_KEYTYPE_NEXT) - return event; - - if (![self shouldInterceptMediaKeyEvents]) - return event; - - [self performSelectorOnMainThread:@selector(handleAndReleaseMediaKeyEvent:) withObject:nsEvent waitUntilDone:NO]; - - return NULL; -} - -static CGEventRef tapEventCallback(CGEventTapProxy proxy, CGEventType type, CGEventRef event, void *refcon) -{ - @autoreleasepool { - CGEventRef ret = tapEventCallback2(proxy, type, event, refcon); - return ret; - } -} - -- (void)handleAndReleaseMediaKeyEvent:(NSEvent *)event -{ - [_delegate mediaKeyTap:self receivedMediaKeyEvent:event]; -} - -- (void)eventTapThread -{ - _tapThreadRL = CFRunLoopGetCurrent(); - CFRunLoopAddSource(_tapThreadRL, _eventPortSource, kCFRunLoopCommonModes); - CFRunLoopRun(); -} - - -#pragma mark - -#pragma mark Task switching callbacks - -- (void)mediaKeyAppListChanged -{ - #ifdef DEBUG_SPMEDIAKEY_APPLIST - [self debugPrintAppList]; - #endif - - if([_mediaKeyAppList count] == 0) - return; - - NSRunningApplication *thisApp = [NSRunningApplication currentApplication]; - NSRunningApplication *otherApp = [_mediaKeyAppList firstObject]; - - BOOL isCurrent = [thisApp isEqual:otherApp]; - - [self setShouldInterceptMediaKeyEvents:isCurrent]; -} - -- (void)frontmostAppChanged:(NSNotification *)notification -{ - NSRunningApplication *app = [notification.userInfo objectForKey:NSWorkspaceApplicationKey]; - if (app.bundleIdentifier == nil) - return; - - if (![[SPMediaKeyTap mediaKeyUserBundleIdentifiers] containsObject:app.bundleIdentifier]) - return; - - [_mediaKeyAppList removeObject:app]; - [_mediaKeyAppList insertObject:app atIndex:0]; - [self mediaKeyAppListChanged]; -} - -- (void)appTerminated:(NSNotification *)notification -{ - NSRunningApplication *app = [notification.userInfo objectForKey:NSWorkspaceApplicationKey]; - [_mediaKeyAppList removeObject:app]; - - [self mediaKeyAppListChanged]; -} - -#ifdef DEBUG_SPMEDIAKEY_APPLIST -- (void)debugPrintAppList -{ - NSMutableString *list = [NSMutableString stringWithCapacity:255]; - for (NSRunningApplication *app in _mediaKeyAppList) { - [list appendFormat:@" - %@\n", app.bundleIdentifier]; - } - NSLog(@"List: \n%@", list); -} -#endif - -@end diff --git a/CMakeLists.txt b/CMakeLists.txt index 3fb151ebd..12c2a9588 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -272,9 +272,7 @@ else() endif() if(APPLE) - add_subdirectory(3rdparty/SPMediaKeyTap) - set(SPMEDIAKEYTAP_INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/3rdparty/SPMediaKeyTap) - set(SPMEDIAKEYTAP_LIBRARIES SPMediaKeyTap) + find_package(SPMediaKeyTap REQUIRED) endif() if(WIN32) diff --git a/debian/copyright b/debian/copyright index e74f11ac9..1b1af95c2 100644 --- a/debian/copyright +++ b/debian/copyright @@ -261,11 +261,6 @@ Files: src/widgets/qsearchfield_nonmac.cpp Copyright: 2011, Mike McQuaid License: Expat -Files: 3rdparty/SPMediaKeyTap/* -Copyright: 2010, Spotify AB - 2011, Joachim Bengtsson -License: BSD-3-clause - Files: 3rdparty/kdsingleapplication/* Copyright: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company License: MIT diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 79f7284c9..b1cb363db 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -1223,7 +1223,7 @@ if(APPLE) "-framework IOKit" "-framework ScriptingBridge" ) - target_link_libraries(strawberry_lib PRIVATE ${SPMEDIAKEYTAP_LIBRARIES}) + target_link_libraries(strawberry_lib PRIVATE SPMediaKeyTap) endif() if(WIN32) diff --git a/src/core/mac_startup.mm b/src/core/mac_startup.mm index cf45b277d..f21a3e014 100644 --- a/src/core/mac_startup.mm +++ b/src/core/mac_startup.mm @@ -41,7 +41,7 @@ #import -#import "3rdparty/SPMediaKeyTap/SPMediaKeyTap.h" +#import #include "config.h"