CLI option "--bypass (-b)" stopped working

[ulville]

EasyEffects Version

8.0.0

What package are you using?

Flatpak (Flathub)

Distribution

Fedora 43

Describe the bug

Hi! I'm the dev of the Gnome Shell Extension. After investigating this issue I realised that --bypass {} -b {} cli options does not work as intended on EasyEffects version 8.0.0. Instead of changing or printing the global bypass state it simply opens the EasyEffects window.

Expected Behavior

No response

Debug Log

Debug Log

Paste your log here

Additional Information

No response

[wwmm]

Now I see I totally forgot to bring this back. I've updated our master branch with the bypass command line. As in the past setting it to 1 enables the bypass and setting to 2 disables it. But for now there isn't a way to get the current value like it was possible to do with the 3 value.

The interaction of third party tools with our database now we do not use gsettings has to be done in a totally different. The ideal way is to connect to our local server. We have a function in place to get some plugins values

easyeffects/src/local_server.cpp

Line 201 in cc7d5b2

auto LocalServer::get_property(const std::string& pipeline,

but there is nothing for the bypass property yet.

Maybe for you is enough just setting the value. In this case the command line option for the bypass is enough. But if you need to get the bypass value and talking to our QT local server based on https://doc.qt.io/qt-6/qlocalserver.html is viable let me know. Adding one more function to the local server that allows the keys like the bypass to be read should not be a big problem.

[ulville]

Thanks for the quick fix for 1 and 2 options 🙏 To display the correct bypass state as a toggle switch I'll need to read the current bypass value. I can probably use the local server method but unfortunetaly until now, I had little to no idea how to connect to and get or set values through such socket server from a GJS GNOME Extension. Probably using Gio.SocketClient but I still need to do more reading and testing on the subject

[attractedtofire]

Hello there!

I'd drop in here to bump this feature request (if just to see if anybody else might have a similar use-case).

I've been and am using the CLI to control Easyeffects in various environments and being able to get the bypass state was indeed very useful. (Having some hint if you are currently having any effect chain enabled without having to open go back to a GUI and opening the EasyEffects window is - depending on environment and situation - between nice to have and a fairly "big deal").

Ideally a way to get the state via CLI would be greatly appreciated (and also, I feel, more internally consistent comparing to -s/--last-loaded-presets). But any way to programatically get the on/off state would be better than none.

Be that as it may: THANKS for the great work!

Best

[Digitalone1]

Having a CLI option to toggle the bypass is very handy. The global bypass is exposed through the XDG global shortcuts, but this protocol is hard and complex, so at the moment it fully works only on Plasma.

With a CLI option a user can bind the command to a shortcut key in whichever DE and use it like the an XDG global shortcut, but it's easy, straightforward and the user can still modify the key while this mechanism is broken (at the moment) on Gnome.

When this will be implemented, I'll disable the XDG global shortcuts (which is a source of issues) in Easy Effects and will make a custom bypass shortcut from Gnome settings.

[wwmm]

Implemented. As far as I can see it seems fine.

[Digitalone1]

Implemented. As far as I can see it seems fine.

It's still not ideal because, in order toggle the bypass, the user has to retrieve the state and then set the value based on the returned one. This requires basically a command line script.

This is way better:

if (parser->isSet("bypass-toggle")) {
  DbMain::setBypass(!DbMain::bypass());

  Q_EMIT onHideWindow();

  QCoreApplication::exit(EXIT_SUCCESS);
}

Besides, I wonder why we invoke the local client to set the bypass for cli b option while we can get/set it directly from/to the database:

if (value == "1") {
    DbMain::setBypass(true);
  } else if (value == "2") {
    DbMain::setBypass(false);
  } else if (value == "3") {
    std::cout << DbMain::bypass() << '\n';
  }

@wwmm Is it okay if I make a PR with these changes?

[Digitalone1]

Well, I tested it and it's not working. The bypass does not change state. But now I wonder why it's working with the global shortcut. 🤔

@wwmm The database is not accessible from the command line?

[wwmm]

It's still not ideal because, in order toggle the bypass, the user has to retrieve the state and then set the value based on the returned one. This requires basically a command line script.

It seems fine to me. But we probably should remove the older mode in this case. Having two different command line options that control the global bypass seems excessive. It will probably be better to have bypass-toggle and something like bypass-state.

Besides, I wonder why we invoke the local client to set the bypass for cli b option while we can get/set it directly from/to the database:

It has to be this way. The secondary instance only sees database values that were already saved to the database file. And even if the primary instance changes something in the database file while the secondary instance is running there won't be any notification to the secondary instance about that. It is the disadvantage of not having an external server managing the database.

The only way to make sure the secondary instance gets the correct value in this case is through the local client and server communication.

[wwmm]

But we probably should remove the older mode in this case.

By this I meant bypass-state should just return the state and nothing more. So instead of --bypass value we should have just bypass-toggle to alternate states and bypass-state to get the current state. Both would not need a value argument in this case.

[Digitalone1]

@wwmm I suppose there are various tools that rely on the current format, so I didn't plan to change it.

Tell me what to do. I plan to add the bypass toggle with the calls to the local server.

[wwmm]

Well, I tested it and it's not working. The bypass does not change state. But now I wonder why it's working with the global shortcut.

Which command did not work? The commands easyeffects -b value with value equal to 1,2 or 3 are working on my computer. I can turn the global bypass on and off as well as getting its state.

I suppose there are various tools that rely on the current format, so I didn't plan change it.

Yes. That is something to consider. Although it should not be too hard for people to update their codes.