Add Linux browser panel support [CEF 4280 / Chromium 87]

[cg2121]

TODO

• Needs more testing (tested on Ubuntu 20.04 with QT 5.12.8)
• Un-hardcode obs-browser.so lookup
• Fix random crashes that sometimes happen

Description

Add Linux browser panel support.

Motivation and Context

Bringing the browser plugin to parity with Windows.

How Has This Been Tested?

Needs testing on other OSs to make sure it doesn't break anything.

Types of changes

• New feature (non-breaking change which adds functionality)

Checklist:

• My code has been run through clang-format.
• I have read the contributing document.
• My code is not on the master branch.
• The code has been tested.
• All commit messages are properly formatted and commits squashed where appropriate.
• I have included updates to all appropriate documentation.

[RytoEX]

Just a few notes based on a visual readthrough. I imagine between this and #197, one will need rebased when the other is merged.

[cg2121]

All requested fixes in the review are now fixed.

[RytoEX]

A couple more things.

[WizardCM]

Ubuntu 20.04:

error: X Error: BadWindow (invalid Window parameter), Major opcode: XI_BadMode (invalid Mode parameter), Minor opcode: 46, Serial: 250

When I create a custom browser dock.

terminate called after throwing an instance of 'std::logic_error'
what(): basic_string::_M_construct null not valid
Aborted (core dumped)

When I try to open the Service Integration window (specifically to connect Twitch).

Browser sources work fine.

[WizardCM]

OK, after a bit of debugging myself, the cause for the second error above is

obs-browser/panel/browser-panel.cpp

Line 99 in ce8f6f8

CefString(&settings.cache_path) = path.Get();

Essentially, path.Get() returns null.

obs-browser/panel/browser-panel.cpp

Lines 82 to 83 in ce8f6f8

	BPtr<char> rpath = obs_module_config_path(storage_path.c_str());
	BPtr<char> path = os_get_abs_path_ptr(rpath.Get());

I think this is because the value it's based on, rpath, ends up being an absolute path rather than an expected relative path, so the conversion fails.

[cg2121]

Service integration should be working with the latest push.

[WizardCM]

error: X Error: BadWindow (invalid Window parameter), Major opcode: XI_BadMode (invalid Mode parameter), Minor opcode: 46, Serial: 250

I've spent a few hours trying to bypass this error. No luck. If I remove the windowInfo.SetAsChild call, a secondary window does open, but that's not the goal.

I tried a number of variations, including using this->effectiveWindowId() or manually setting windowInfo.parent_window. Everything would return the same error.

The only way I was able to change the behaviour is using XConfigureWindow and XReparentWindow after CreateBrowserSync, which leaves an extra empty black window which then freaks out and cannot be closed. The panel itself renders correctly but cannot be interacted with or resized.

I don't know X well enough to be able to do this using X functions correctly.

[cg2121]

@WizardCM could you check if it works better for you now? I removed all of the QT functions from the CEF threads, and it seems it is more stable. It also seemed to work better on the latest CEF (CEF 4280).

[WizardCM]

@cg2121 Nice work! I can confirm that they now correctly appear inside the dock (and within the Service Integration login container).

As a side note, I'm using CEF 4183 as that's what we hope to upgrade to.

However, while the child windows are correctly added, the following things don't work:

1. I cannot click within the webpage to interact with it (either within a dock, or service integration login)
2. Resizing the dock/login doesn't resize the webpage, and instead shows the empty container
3. When closing service integration login, both BadWindow: 25 and BadWindow: BadName occur (if I resize before closing, I also get BadWindow: BadColor for every resize event) Fixed in CEF 4280
4. After triggering 3, on shutdown I get Trace/breakpoint trap (core dumped) - the breakpoint is at ../sysdeps/nptl/futex-internal.h Fixed in CEF 4280

[cg2121]

@WizardCM the crash on exit appears to only happen on CEF 4183, but resizing and clicking work fine for me.

[WizardCM]

@cg2121 Hmm, in that case I might try bumping to 4240 or 4280 for my testing.

I doubt that'll fix resizing and clicking though, if my experience so far is anything to go by. :(

[WizardCM]

@cg2121 I can confirm that 4240 doesn't have any change in behaviour at all, but 4280 fixes the crash on shutdown and the two BadWindow errors when closing service integration login.

The rest of the issues remain.

[RytoEX]

Needs testing on other OSs to make sure it doesn't break anything.

What OS did you test on so far? Can you please add that information to the original post?

[cg2121]

I've tested it so far on Ubuntu 20.04 with QT 5.12.8.

[phedders]

On Fri, 2020-12-11 at 11:44 -0800, Clayton Groeneveld wrote: I've tested it so far on Ubuntu 20.04 with QT 5.12.8.

I've been testing on Debian Unstable - QT 5.15 - cef_binary_87.1.11+g8bb7705+chromium-87.0.4280.66_linux64 - obs-studio HEAD - obs-browser remotes/lbp/linux-browser-panels 24c371a So far everything I have thrown at it has worked. - enable gpu works brilliantly. - docks work - browser windows work perfect - no errors or crashes so far - ninja and other GPU intensives work really well with --enable-gpu For my builds I'm using this to make starting with Accell easy.

…

commit 3cdddbb06910ffa6705041340b80c8f556114d7c Author: Paul Hedderly ***@***.***> Date: Mon Dec 7 22:10:03 2020 +0000 prh: change desktop file for accell diff --git a/UI/xdg-data/com.obsproject.Studio.desktop b/UI/xdg- data/com.obsproject.Studio.desktop index 4b753a4f5..cdf466e95 100644 --- a/UI/xdg-data/com.obsproject.Studio.desktop +++ b/UI/xdg-data/com.obsproject.Studio.desktop @@ -6,7 +6,7 @@ GenericName[fr]=Logiciel d'enregistrement/diffusion Comment=Free and Open Source Streaming/Recording Software Comment[fr]=Logiciel libre d'enregistrement et de diffusion sur Internet Comment[ru]=Бесплатная программа с открытым кодом для записи/трансляции видео -Exec=obs +Exec=obs --enable-gpu --enable-media-stream Icon=com.obsproject.Studio Terminal=false Type=Application

[cg2121]

@WizardCM by chance, are you using a VM to test it?

[WizardCM]

@WizardCM by chance, are you using a VM to test it?

Correct, I'm using my PXE boot in a Hyper-V VM. For some reason it has had trouble booting on real hardware recently, I hope to troubleshoot that this weekend.

[cg2121]

The obs-browser library lookup is now un-hardcoded. Requires obsproject/obs-studio#3871 to work.

[eNBeWe]

I just built this code on Ubuntu 20.04:

• With the CEF version from the obs-studio documentation (3770) the browser contents are super tiny (approx 1% zoom level)
• With CEF 4280 the first tests look quite promising
  • The embedded browser is unable to play twitch streams. I would like to use it to monitor the outgoing stream, which doesn't work because of this.
  • Apart from that it seems to be able to do what I need it to do
• I would like to test the twitch integrations, but can't authenticate to twitch with the locally built version.

[cg2121]

I've fixed the Windows resize issue. All I had to do was to set the window container as frameless.

[WizardCM]

I can confirm that the lib lookup function works perfectly, even with nonstandard locations for OBS.

Heads up: the issues I was running into with resizing and interaction are caused by the USE_QT_LOOP CMake flag, which is designed to fix conflicts between Qt, CEF & GTK. I have this enabled to emulate production builds as much as possible. Getting browser panels to work properly with this flag will require a fair bit of rework of the panel code, but should solve a lot of issues.

• With the CEF version from the obs-studio documentation (3770) the browser contents are super tiny (approx 1% zoom level)

@eNBeWe This is why we use 3809 on Linux. Basically, 3770 doesn't seem to set the default font size, so all text is tiny (everything else should be fine). Alternatively, add this commit.

• The embedded browser is unable to play twitch streams. I would like to use it to monitor the outgoing stream, which doesn't work because of this.

This is likely because non-free codecs are not enabled in Spotify builds.

[cg2121]

With the newer CEF versions (tested with 4280), the USE_QT_LOOP on Linux doesn't seem necessary. From what I can tell, the crashes don't happen anymore with newer CEF versions, as I haven't been able to reproduce them.

[cg2121]

If that turns out to be the case, then this PR is ready to go.

[cg2121]

Confirmed with another developer that they aren't getting the crashes anymore either, so as is this can be merged without problems, at least for Linux.

[PatTheMav]

OK, after a bit of debugging myself, the cause for the second error above is

obs-browser/panel/browser-panel.cpp

Line 99 in ce8f6f8

CefString(&settings.cache_path) = path.Get();

Essentially, path.Get() returns null.

obs-browser/panel/browser-panel.cpp

Lines 82 to 83 in ce8f6f8

	BPtr<char> rpath = obs_module_config_path(storage_path.c_str());
	BPtr<char> path = os_get_abs_path_ptr(rpath.Get());

I think this is because the value it's based on, rpath, ends up being an absolute path rather than an expected relative path, so the conversion fails.

@tbodt added a fix for this in #197, so maybe adapt that here as well?

I guess merging #197 first makes sense, then the PRs for "modern" CEF versions required for macOS (because that would include CEF 4280 as well), and finally this PR?

[cg2121]

I've added the fix from #197. It also works on Linux without problems.

[flexiondotorg]

Thank for working on this! I've been testing on Ubuntu 20.04 with OBS 26.0.1 with the following patches applied:

• libobs: Add function to get module lib obs-studio#3871
• Add Linux browser panel support [CEF 4280 / Chromium 87] #254

I've also dropped USE_QT_LOOP=TRUE from my build. Working great, no issues encountered.

[LiamDawe]

Tested the Snap package mentioned to me by @flexiondotorg ( https://snapcraft.io/obs-studio ), looking good over here on Arch Linux. Docked my Twitch chat window without issues.

[WizardCM]

@cg2121 Now that macOS panel support has been merged, please rebase your branch.

In the meantime, I'm going to try and get USE_QT_LOOP on linux to behave, just so we don't destroy existing configurations if possible. It won't be a requirement for this PR to be merged, but it's something I think would be worth doing.

[cg2121]

It has been updated to the latest master.

[Krutonium]

I managed to get this going, but when I tried to embed https://pretzel.rocks/ the player seems to be unable to function - it errors out playing each song and immediately skips to the next song.