fix build and key shortcuts on macOS + disable AppNap #1705

matatata · 2023-08-25T09:00:06Z

The qxt-mini library did not properly register keyboards presses and releases. I've fixed that. Without that the center binding would cause opentrack to always keep centering for instance. I also made small other tweaks to be able to build and run it.

sthalik · 2023-08-25T10:52:09Z

I already cherry-picked the qxt-mini fix. It was a long time coming, thank you.

The macdeployqt change can't be merged, as Qt can be installed from anything from the official installer, macports, homebrew, or straight from the source code. So expecting the user to set up PATH is more of a general solution.

If the qApp assert fails, something's wrong. I guess it's before main? It should never be called like that. It becomes legal to call once QApplication gets instantiated. If it's called after it does and still crashes, then it can be something worse like multiple versions of Qt linked into the same process.

matatata · 2023-08-25T13:55:54Z

Hi, I'm glad you could use some of my changes. In fact the keyboard change is the most important one. I'm not sure why the assert failed, but when I take it away the program works just fine.

There's one other important thing I noticed: macOS is throttling the process when in background rendering it somewhat useless. The feature is called AppNap and I've been looking into the docs and apparently you can write some code to let macOS know it should not throttle the process... such as

http://arsenkin.com/Disable-app-nap.html

https://developer.apple.com/library/archive/documentation/Performance/Conceptual/power_efficiency_guidelines_osx/PrioritizeWorkAtTheAppLevel.html#//apple_ref/doc/uid/TP40013929-CH36-SW1

If I only knew how to add some objective-c code to the project I might be able to try things out. Do you have a clue where to put the code best? I'm struggling with all the make boilerplates and I just cannot figure out how to make the adaptations.

sthalik · 2023-08-25T14:08:23Z

If I only knew how to add some objective-c code to the project I might be able to try things out. Do you have a clue where to put the code best?

Try adding it after a space character.

file(GLOB cxx CONFIGURE_DEPENDS "${dir}/*.cpp" "${dir}/*.m" "${dir}/*.mm")

The actual objc file extension notwithstanding.

sthalik · 2023-08-25T15:40:10Z

opentrack/AppNapLib/CMakeLists.txt

+       lib.m
+    )
+
+    enable_language(OBJCXX)


Add around enable_language(RC) in toplevel cmakelists.txt.

if(APPLE) enable_language(OBJCXX) endif()

sthalik · 2023-08-25T15:40:36Z

opentrack/AppNapLib/CMakeLists.txt

+    enable_language(OBJCXX)
+
+
+    add_library(AppNapLib SHARED


Link statically.

sthalik · 2023-08-25T15:41:21Z

opentrack/AppNapLib/CMakeLists.txt

+
+    )
+
+    target_link_libraries(AppNapLib


With STATIC, try target_link_libraries(AppNapLib INTERFACE "-framework Foundation").

opentrack/main-window.cpp

sthalik · 2023-08-25T15:44:37Z

opentrack/CMakeLists.txt

 set_source_files_properties(resources.rc OBJECT_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/opentrack.ico")

-target_link_libraries(${self} opentrack-user-interface opentrack-version)
+target_link_libraries(${self} opentrack-user-interface opentrack-version AppNapLib)


Just add another target_link_libraries() line dependent on APPLE.

sthalik · 2023-08-25T17:13:42Z

@matatata, See if this cleaned up diff works for you. If it does, I'm going to commit it with your name on it.

I don't have vmware unlocker installed right now so I can't run run the OSX build for the time being.

patch.diff.txt

matatata · 2023-08-25T17:19:29Z

If I only knew how to add some objective-c code to the project I might be able to try things out. Do you have a clue where to put the code best?

Try adding it after a space character.
file(GLOB cxx CONFIGURE_DEPENDS "${dir}/*.cpp" "${dir}/*.m" "${dir}/*.mm")
The actual objc file extension notwithstanding.

Thank you. That helped indeed. I've made the changes. It was quite simple in the end. It works fine so far.. no throttling any more. Please have a look at the latest commit.

matatata · 2023-08-25T17:23:14Z

oh I just see that you had commented my previous attempt. As you can see I threw most of it away.

sthalik · 2023-08-25T17:23:29Z

The cmake code still isn't ok. Just test this patch via git apply on a clean repo and come back to me. This way we avoid a longer back-and-forth with me having to nitpick trivial lines in the commit.

matatata · 2023-08-25T17:24:55Z

I'll work in your cleanups ..you sent me. sorry did not realise. was too focussed..

matatata · 2023-08-25T17:29:13Z

I'm done so far. Unfortunately the *.mm change broke the linux build. Maybe you can help? I need to go now. Will check back later. CU

matatata · 2023-08-25T23:36:41Z

Hi, the changes in your patches are good and do work except that I needed to add STATIC to the new target_sources directive in opentrack/CMakeLists.txt I committed and pushed it to my fork: da767ee I have also removed all other commits that very indeed unnecessary, so you could cherry-pick that one app nap commit or use this patch I created. diff --git a/opentrack/CMakeLists.txt b/opentrack/CMakeLists.txt index 9bf5cb9b..0fd72475 100644 --- a/opentrack/CMakeLists.txt +++ b/opentrack/CMakeLists.txt @@ -13,4 +13,13 @@ set_target_properties(opentrack-executable PROPERTIES set_source_files_properties(resources.rc OBJECT_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/opentrack.ico") +if(APPLE) + set_source_files_properties(appnap_mac.mm PROPERTIES COMPILE_FLAGS "-fno-objc-arc") + target_sources(${self} PRIVATE appnap_mac.mm) +endif() + target_link_libraries(${self} opentrack-user-interface opentrack-version) + +if(APPLE) + target_link_libraries(${self} "-framework Foundation") +endif() diff --git a/opentrack/appnap_mac.mm b/opentrack/appnap_mac.mm new file mode 100644 index 00000000..3e0bea73 --- /dev/null +++ b/opentrack/appnap_mac.mm @@ -0,0 +1,47 @@ +#ifdef __APPLE__ + +#import <Foundation/Foundation.h> + +/** + * Used to prevent macOS from throttling the opentrack process. + */ + +id token = nil; + +void disable_appnap_start(); +void disable_appnap_stop(); + +void disable_appnap_start() { + + if(token){ + NSLog(@"disable_appnap_start: already started"); + return; + } + + + NSLog(@"disable_appnap_start"); + token = [[NSProcessInfo processInfo] + beginActivityWithOptions: NSActivityUserInitiatedAllowingIdleSystemSleep + reason: @"Disable AppNap"]; + [token retain]; +} + +void disable_appnap_stop() { + if(!token){ + NSLog(@"disable_appnap_start: not started"); + return; + } + + NSLog(@"disable_appnap_stop"); + [[NSProcessInfo processInfo] endActivity:token]; + [token release]; + token = nil; +} + + + +#endif + + + + diff --git a/opentrack/main-window.cpp b/opentrack/main-window.cpp index f449845b..20506d81 100644 --- a/opentrack/main-window.cpp +++ b/opentrack/main-window.cpp @@ -32,6 +32,12 @@ #include <QDir> #include <QDateTime> + +#ifdef __APPLE__ +void disable_appnap_start(); +void disable_appnap_stop(); +#endif + extern "C" const char* const opentrack_version; using namespace options::globals; @@ -436,6 +442,11 @@ void main_window::start_tracker_() if (work) return; +#ifdef __APPLE__ + disable_appnap_start(); +#endif + + #ifndef UI_NO_VIDEO_FEED auto* frame = ui.video_frame; #else @@ -486,6 +497,10 @@ void main_window::stop_tracker_() if (!work) return; +#ifdef __APPLE__ + disable_appnap_stop(); +#endif + force_is_visible(true); with_tracker_teardown sentinel; Best regards

…

Am 25.08.2023 um 19:23 schrieb Stanislaw Halik ***@***.***>: The cmake code still isn't ok. Just test this patch via git apply on a clean repo and come back to me. This way we avoid a longer back-and-forth with me having to nitpick trivial lines in the commit. — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: ***@***.***>

sthalik · 2023-08-25T23:45:01Z

Merged, thanks.

With regard to your qApp problem -- you may want to verify whether the assertion trips after QApplication has already been created. If it gets called before that, it's an opentrack bug. Otherwise:

$ DYLD_PRINT_LIBRARIES=1 opentrack 2>&1 | grep Qt | sort

See if there are any duplicates, such as QtCore loaded from 2 different .so's or something.

matatata · 2023-08-26T00:19:59Z

Cool!

With regard to your qApp problem -- you may want to verify whether the assertion trips after QApplication has already been created. If it gets called before that, it's an opentrack bug. Otherwise: $ DYLD_PRINT_LIBRARIES=1 opentrack 2>&1 | grep Qt | sort See if there are any duplicates, such as QtCore loaded from 2 different .so's or something

Yes it is very weird. I build like this: git clone ... cd opentrack mkdir build cd build cmake .. -G "Unix Makefiles" make install # not3e that macqtdeploy does it’s thing as well... Then I get a directory structure: tree -L 1 install install ├── Library ├── Plugins ├── doc ├── opentrack.app └── thirdparty I copy the opentrack.app to /Applications/ If I execute it and then there's the crash and your command lists multiple QT-Libs (I have qt installed via MacPorts.. perhaps that's a problem) DYLD_PRINT_LIBRARIES=1 ./opentrack 2>&1 | grep Qt | sort dyld[50124]: <231AA0A6-892A-3153-9FAD-772B0AE7794E> /Applications/opentrack.app/Contents/Frameworks/QtNetwork.framework/Versions/5/QtNetwork dyld[50124]: <231AA0A6-892A-3153-9FAD-772B0AE7794E> /opt/local/libexec/qt5/lib/QtNetwork.framework/Versions/5/QtNetwork dyld[50124]: <28FAEB0B-3490-390D-9AA5-84949F4C3F49> /Applications/opentrack.app/Contents/Frameworks/QtPrintSupport.framework/Versions/5/QtPrintSupport dyld[50124]: <AD584864-61B5-3314-B217-BC71300B9430> /Applications/opentrack.app/Contents/Frameworks/QtDBus.framework/Versions/5/QtDBus dyld[50124]: <AD584864-61B5-3314-B217-BC71300B9430> /opt/local/libexec/qt5/lib/QtDBus.framework/Versions/5/QtDBus dyld[50124]: <CDF96ABB-CF78-394D-AECD-457451661250> /Applications/opentrack.app/Contents/Frameworks/QtCore.framework/Versions/5/QtCore dyld[50124]: <CDF96ABB-CF78-394D-AECD-457451661250> /opt/local/libexec/qt5/lib/QtCore.framework/Versions/5/QtCore dyld[50124]: <D9A77725-4BDE-34B6-BBDE-F8CD959AD9E6> /Applications/opentrack.app/Contents/Frameworks/QtGui.framework/Versions/5/QtGui dyld[50124]: <D9A77725-4BDE-34B6-BBDE-F8CD959AD9E6> /opt/local/libexec/qt5/lib/QtGui.framework/Versions/5/QtGui dyld[50124]: <F0EE5680-8A1E-3B78-ADA7-277C7EF6975D> /Applications/opentrack.app/Contents/Frameworks/QtMultimedia.framework/Versions/5/QtMultimedia dyld[50124]: <F0EE5680-8A1E-3B78-ADA7-277C7EF6975D> /opt/local/libexec/qt5/lib/QtMultimedia.framework/Versions/5/QtMultimedia dyld[50124]: <FEDF303E-E846-3328-A314-5A6FC53372BE> /Applications/opentrack.app/Contents/Frameworks/QtWidgets.framework/Versions/5/QtWidgets dyld[50124]: <FEDF303E-E846-3328-A314-5A6FC53372BE> /opt/local/libexec/qt5/lib/QtWidgets.framework/Versions/5/QtWidgets objc[50124]: Class KeyValueObserver is implemented in both /opt/local/libexec/qt5/lib/QtCore.framework/Versions/5/QtCore (0x10394a668) and /Applications/opentrack.app/Contents/Frameworks/QtCore.framework/Versions/5/QtCore (0x102cb0668). One of the two will be used. Which one is undefined. objc[50124]: Class QMacAutoReleasePoolTracker is implemented in both /opt/local/libexec/qt5/lib/QtCore.framework/Versions/5/QtCore (0x10394a5c8) and /Applications/opentrack.app/Contents/Frameworks/QtCore.framework/Versions/5/QtCore (0x102cb05c8). One of the two will be used. Which one is undefined. objc[50124]: Class QT_ROOT_LEVEL_POOL__THESE_OBJECTS_WILL_BE_RELEASED_WHEN_QAPP_GOES_OUT_OF_SCOPE is implemented in both /opt/local/libexec/qt5/lib/QtCore.framework/Versions/5/QtCore (0x10394a640) and /Applications/opentrack.app/Contents/Frameworks/QtCore.framework/Versions/5/QtCore (0x102cb0640). One of the two will be used. Which one is undefined. objc[50124]: Class RunLoopModeTracker is implemented in both /opt/local/libexec/qt5/lib/QtCore.framework/Versions/5/QtCore (0x10394a6b8) and /Applications/opentrack.app/Contents/Frameworks/QtCore.framework/Versions/5/QtCore (0x102cb06b8). One of the two will be used. Which one is undefined. When I then delete ├── Library ├── Plugin from the install directory from above, then afterwards it starts fine and your command only shows: DYLD_PRINT_LIBRARIES=1 ./opentrack 2>&1 | grep Qt | sort dyld[50060]: <231AA0A6-892A-3153-9FAD-772B0AE7794E> /Applications/opentrack.app/Contents/Frameworks/QtNetwork.framework/Versions/5/QtNetwork dyld[50060]: <28FAEB0B-3490-390D-9AA5-84949F4C3F49> /Applications/opentrack.app/Contents/Frameworks/QtPrintSupport.framework/Versions/5/QtPrintSupport dyld[50060]: <4212A2A1-42D7-3F2B-AF56-CAB07BF467AF> /Applications/opentrack.app/Contents/Frameworks/QtSerialPort.framework/Versions/5/QtSerialPort dyld[50060]: <AD584864-61B5-3314-B217-BC71300B9430> /Applications/opentrack.app/Contents/Frameworks/QtDBus.framework/Versions/5/QtDBus dyld[50060]: <CDF96ABB-CF78-394D-AECD-457451661250> /Applications/opentrack.app/Contents/Frameworks/QtCore.framework/Versions/5/QtCore dyld[50060]: <D9A77725-4BDE-34B6-BBDE-F8CD959AD9E6> /Applications/opentrack.app/Contents/Frameworks/QtGui.framework/Versions/5/QtGui dyld[50060]: <F0EE5680-8A1E-3B78-ADA7-277C7EF6975D> /Applications/opentrack.app/Contents/Frameworks/QtMultimedia.framework/Versions/5/QtMultimedia dyld[50060]: <FEDF303E-E846-3328-A314-5A6FC53372BE> /Applications/opentrack.app/Contents/Frameworks/QtWidgets.framework/Versions/5/QtWidgets I don't get it. It’s magic. Best regards

…

Am 26.08.2023 um 01:45 schrieb Stanislaw Halik ***@***.***>: Merged, thanks. With regard to your qApp problem -- you may want to verify whether the assertion trips after QApplication has already been created. If it gets called before that, it's an opentrack bug. Otherwise: $ DYLD_PRINT_LIBRARIES=1 opentrack 2>&1 | grep Qt | sort See if there are any duplicates, such as QtCore loaded from 2 different .so's or something. — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: ***@***.***>

sthalik · 2023-08-26T03:12:33Z

Then macdeployqt doesn't run install_name_tool properly. Consider modifying the build process to use the old method.

matatata · 2023-08-26T15:40:59Z

Then macdeployqt doesn't run install_name_tool properly. Consider modifying the build process to use the old method.

Actually I tried to remove the calls of that install-fail-tool script and at least for me macdeployqt does very well. No issues anymore. I could open the binary on a different mac as well. Perhaps it is not needed anymore and does more harm than good.

sthalik · 2023-08-26T15:53:09Z

Just to make it clear, you no longer need to remove the qApp assert as long as install-fail-tool is commented out?

matatata · 2023-08-26T20:45:19Z

Yes. Without the fail tool I can run the build without further action immediately after it is built from clean repo. the show dyn lib command shows no duplicatesAm 26.08.2023 um 17:53 schrieb Stanislaw Halik ***@***.***>: Just to make it clear, you no longer need to remove the qApp assert as long as install-fail-tool is commented out? —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: ***@***.***>

@matatata

Using install-fail-tool with macdeployqt together will load duplicate copies of the shared libraries into the process, leading to crashes. Reported by: @matatata Issue: #1705

sthalik · 2023-08-27T05:13:57Z

It's very important that this got fixed. Thanks for reporting that.

As for macdeployqt's path in the shell script -- generally for Unix systems users are expected to make a symlink to the binaries or simply add them to their PATH. Do you think this should be the case here or not?

sthalik · 2023-08-27T05:15:14Z

There's also another osx issue where qxt-mini doesn't understand keystrokes such as 'home' or 'left arrow'. Since you knew how to fix the lack of the keyup event, you might want to look at that too.

matatata · 2023-08-27T12:01:27Z

It's very important that this got fixed. Thanks for reporting that.

As for macdeployqt's path in the shell script -- generally for Unix systems users are expected to make a symlink to the binaries or simply add them to their PATH. Do you think this should be the case here or not?

I did put it in the PATH eventually. You cannot know in advance where it will be on the user's system, so I think it's ok that the user compiling it needs to symlink it or put it in the PATH.

matatata · 2023-08-27T12:23:00Z

There's also another osx issue where qxt-mini doesn't understand keystrokes such as 'home' or 'left arrow'. Since you knew how to fix the lack of the keyup event, you might want to look at that too.

I just checked and seems all keys work except the keys on the numpad. Yes I plan to take a look at it in future. Out of curiosity: The Freetrack 2.0 Enhanced Output plugin is not available on Mac, because it's some third party thing, right?

sthalik · 2023-08-27T12:23:49Z

The Freetrack 2.0 Enhanced Output plugin is not available on Mac, because it's some third party thing, right?

Use proto/wine. You must set a cache variable for it to become available.

sthalik requested changes Aug 25, 2023

View reviewed changes

matatata force-pushed the master branch 2 times, most recently from 7be6157 to 6dae83a Compare August 25, 2023 17:02

matatata force-pushed the master branch from 6dae83a to a9c0af5 Compare August 25, 2023 17:17

matatata changed the title ~~fix build and key shortcuts on macOS~~ fix build and key shortcuts on macOS + disable AppNap Aug 25, 2023

matatata force-pushed the master branch from a9c0af5 to 89851bd Compare August 25, 2023 17:28

matatata force-pushed the master branch from 89851bd to da767ee Compare August 25, 2023 23:10

sthalik approved these changes Aug 25, 2023

View reviewed changes

sthalik added a commit that referenced this pull request Aug 27, 2023

osx: use macdeployqt properly

b04381b

Using install-fail-tool with macdeployqt together will load duplicate copies of the shared libraries into the process, leading to crashes. Reported by: @matatata Issue: #1705

matatata closed this Aug 27, 2023

matatata force-pushed the master branch from ea66273 to b04381b Compare August 27, 2023 15:45

sthalik mentioned this pull request Jan 28, 2024

Create GitHub Action workflow for building project on Windows, Linux and macOS #1127

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix build and key shortcuts on macOS + disable AppNap #1705

fix build and key shortcuts on macOS + disable AppNap #1705

matatata commented Aug 25, 2023

sthalik commented Aug 25, 2023

matatata commented Aug 25, 2023 •

edited

Loading

sthalik commented Aug 25, 2023

sthalik Aug 25, 2023

sthalik Aug 25, 2023

sthalik Aug 25, 2023

sthalik Aug 25, 2023

sthalik commented Aug 25, 2023 •

edited

Loading

matatata commented Aug 25, 2023 •

edited

Loading

matatata commented Aug 25, 2023

sthalik commented Aug 25, 2023

matatata commented Aug 25, 2023

matatata commented Aug 25, 2023

matatata commented Aug 25, 2023 via email

sthalik commented Aug 25, 2023

matatata commented Aug 26, 2023 via email

sthalik commented Aug 26, 2023

matatata commented Aug 26, 2023 •

edited

Loading

sthalik commented Aug 26, 2023

matatata commented Aug 26, 2023 via email

sthalik commented Aug 27, 2023

sthalik commented Aug 27, 2023

matatata commented Aug 27, 2023

matatata commented Aug 27, 2023

sthalik commented Aug 27, 2023

fix build and key shortcuts on macOS + disable AppNap #1705

fix build and key shortcuts on macOS + disable AppNap #1705

Conversation

matatata commented Aug 25, 2023

sthalik commented Aug 25, 2023

matatata commented Aug 25, 2023 • edited Loading

sthalik commented Aug 25, 2023

sthalik Aug 25, 2023

Choose a reason for hiding this comment

sthalik Aug 25, 2023

Choose a reason for hiding this comment

sthalik Aug 25, 2023

Choose a reason for hiding this comment

sthalik Aug 25, 2023

Choose a reason for hiding this comment

sthalik commented Aug 25, 2023 • edited Loading

matatata commented Aug 25, 2023 • edited Loading

matatata commented Aug 25, 2023

sthalik commented Aug 25, 2023

matatata commented Aug 25, 2023

matatata commented Aug 25, 2023

matatata commented Aug 25, 2023 via email

sthalik commented Aug 25, 2023

matatata commented Aug 26, 2023 via email

sthalik commented Aug 26, 2023

matatata commented Aug 26, 2023 • edited Loading

sthalik commented Aug 26, 2023

matatata commented Aug 26, 2023 via email

sthalik commented Aug 27, 2023

sthalik commented Aug 27, 2023

matatata commented Aug 27, 2023

matatata commented Aug 27, 2023

sthalik commented Aug 27, 2023

matatata commented Aug 25, 2023 •

edited

Loading

sthalik commented Aug 25, 2023 •

edited

Loading

matatata commented Aug 25, 2023 •

edited

Loading

matatata commented Aug 26, 2023 •

edited

Loading