Skip to content

add tray icon #1035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Mar 15, 2023
Merged

add tray icon #1035

merged 1 commit into from
Mar 15, 2023

Conversation

ReenigneArcher
Copy link
Member

@ReenigneArcher ReenigneArcher commented Mar 12, 2023 •
edited
Loading

Description

This PR adds a system tray icon. There's not much to it right now, but it should open the avenue for tray notifications (e.g. pairing request, stream started, stream ended, etc. etc.).

I used https://github.com/dmikushin/tray which is a cross platform system tray library, but I have not tested this on macOS or Linux yet. I am not sure how to specify the icon image for Linux, or if it's even possible.

Todo:

  • Determine why Sunshine doesn't exit cleanly (before merging this)
  • Compile on Linux
  • Compile on macOS
  • Fix runtime error on macOS
  • Get icon to appear on macOS (must create tray icon in main thread on macOS dmikushin/tray#10)
    • Unable to get tray icon created on macOS since it requires creating/updating UI elements on the main thread, so forgoing this for now. If anyone has any ideas, feel free to submit a PR.
  • Add deps for Flatpak
    • In order to not hold this PR up, Flatpak can be improved later. Some code added to make the tray icon conditional on Linux depending on if the required deps are available.
  • Use boost/locale to translate menu entries
    • Can be a later PR.

Screenshot

Windows

image
image

Ubuntu
image

Issues Fixed or Closed

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update (updates to dependencies)
  • Documentation update (changes to documentation)
  • Repository update (changes to repository files, e.g. .github/...)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

  • I want maintainers to keep my branch updated

@ReenigneArcher ReenigneArcher marked this pull request as draft March 12, 2023 22:57
@ReenigneArcher ReenigneArcher force-pushed the add-tray-icon branch 4 times, most recently from fbb7431 to 8f4eb19 Compare March 13, 2023 00:31
@ReenigneArcher ReenigneArcher added the help wanted Extra attention is needed label Mar 13, 2023
@ReenigneArcher ReenigneArcher force-pushed the add-tray-icon branch 14 times, most recently from a78c463 to 6bf8830 Compare March 13, 2023 23:21
@ReenigneArcher
Copy link
Member Author

ReenigneArcher commented Mar 14, 2023 •
edited
Loading

Getting a runtime error on macOS.

2023-03-13 20:58:20.624 sunshine[21904:70290] *** Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: 'NSWindow drag regions should only be invalidated on the Main Thread!'
*** First throw call stack:
(
	0   CoreFoundation                      0x00007ff80ceb243b __exceptionPreprocess + 242
	1   libobjc.A.dylib                     0x00007ff80ca01e25 objc_exception_throw + 48
	2   CoreFoundation                      0x00007ff80ceda5d6 _CFBundleGetValueForInfoKey + 0
	3   AppKit                              0x00007ff80ff81161 -[NSWindow(NSWindow_Theme) _postWindowNeedsToResetDragMarginsUnlessPostingDisabled] + 307
	4   AppKit                              0x00007ff80ff6df4f -[NSWindow _initContent:styleMask:backing:defer:contentView:] + 1247
	5   AppKit                              0x00007ff80ff6da69 -[NSWindow initWithContentRect:styleMask:backing:defer:] + 42
	6   AppKit                              0x00007ff81071b6fe -[NSStatusBarWindow initForStatusItem:] + 88
	7   AppKit                              0x00007ff81071e623 -[NSStatusItem _initWithStatusBar:length:priority:systemInsertOrder:] + 349
	8   AppKit                              0x00007ff8101daef2 -[NSStatusBar _statusItemWithLength:withPriority:] + 76
	9   sunshine-0.18.4                     0x0000000105a32e1f tray_init + 120
	10  sunshine-0.18.4                     0x00000001059555ce _Z11create_trayv + 29
	11  sunshine-0.18.4                     0x000000010595949f _ZNSt3__1L14__thread_proxyINS_5tupleIJNS_10unique_ptrINS_15__thread_structENS_14default_deleteIS3_EEEEPFivEEEEEEPvSA_ + 36
	12  libsystem_pthread.dylib             0x00007ff80cd5f259 _pthread_start + 125
	13  libsystem_pthread.dylib             0x00007ff80cd5ac7b thread_start + 15
)
libc++abi: terminating with uncaught exception of type NSException
zsh: abort      sunshine

macOS running now... but tray icon is not created and no boost message is printed to stdout...

@ReenigneArcher ReenigneArcher force-pushed the add-tray-icon branch 9 times, most recently from 9a4c300 to 8a2dd16 Compare March 14, 2023 14:59
@ReenigneArcher ReenigneArcher force-pushed the add-tray-icon branch 2 times, most recently from 07156fe to 312b726 Compare March 14, 2023 17:48
@ReenigneArcher
Copy link
Member Author

@abusse sorry for the ping, but wondering if you could review this. I'm struggling to get the tray icon created in macOS. macOS doesn't allow creating the icon outside of the main thread, but the tray requires an endless loop for listening to events.

I tried creating the icon in the main thread but running the tray_loop in another thread, but that did not seem to pick up the events for the tray icon.

@ReenigneArcher ReenigneArcher force-pushed the add-tray-icon branch 6 times, most recently from a35c64f to 77d99a3 Compare March 15, 2023 17:44
@ReenigneArcher ReenigneArcher marked this pull request as ready for review March 15, 2023 20:14
@ReenigneArcher ReenigneArcher merged commit 014d693 into nightly Mar 15, 2023
@ReenigneArcher ReenigneArcher deleted the add-tray-icon branch March 15, 2023 20:30
@bruglet

This comment was marked as off-topic.

Sign in to view
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ReenigneArcher @bruglet