An audio effect processor for PipeWire and PulseAudio clients
Features • Installation • Scripting/API • Contributors • License
Linux port developed by Tim Schneeberger (@thepbone)
JamesDSP was initially published as an audio effects processor
for Android devices and is written by James Fung (@james34602).
Feel free to join our Telegram group for support and updates
Please help us to translate this app on Crowdin!
Designed for use with PipeWire. PulseAudio is only supported for backward compatibility.
PipeWire has a much lower latency compared to PulseAudio when injecting audio effects processors into the audio pipeline. I'm currently not planning to add more advanced support for PulseAudio clients. Features such as selective app exclusion, changing the target audio device, and similar features will only be available to PipeWire clients.
Follow the instructions below if you don't know which one your Linux distribution is using. If you already know, skip to the 'Install dependencies' section.
Run LC_ALL=C pactl info | grep "Server Name:"
in your terminal.
If you are using Pipewire the output should look similar to this:
Server Name: PulseAudio (on PipeWire 0.3.35)
If you are using Pulseaudio the output should look exactly like this:
Server Name: pulseaudio
Decide whether you need to install the PipeWire or PulseAudio version of this app!
If you don't know which version fits your Linux setup, go to the PipeWire vs PulseAudio section above.
It is recommended to switch to PipeWire, if possible. JamesDSP's audio backend for PulseAudio is in maintenance-mode; however, it will continue to receive UI-related feature updates.
The installation instructions for the PulseAudio version have been moved to a separate file: INSTALL_PULSE.md.
This section is dedicated to systems using PipeWire as the audio server. If you are still using PulseAudio, please go here.
Universal binary packages for all distros.
The recommended Pipewire version is available for download on FlatHub: https://flathub.org/apps/me.timschneeberger.jdsp4linux
flatpak install me.timschneeberger.jdsp4linux
If you are still using PulseAudio, you need to download the legacy package from my personal repository:
sudo flatpak remote-add --if-not-exists thepbones-repo https://raw.githubusercontent.com/ThePBone/flatpak-repo/main/thepbone.flatpakrepo
flatpak install me.timschneeberger.jdsp4linux.pulse
[!IMPORTANT] Flatpaks are sandboxed. This application can only access
~/.var/app/me.timschneeberger.jdsp4linux/
by default.
AUR packages are available:
Stable version
yay -S jamesdsp
Development version
yay -S jamesdsp-git
Package maintained by @theAeon on Fedora COPR. Built for Fedora 34/35/Rawhide and OpenSUSE Tumbleweed.
yum copr enable arrobbins/JDSP4Linux && yum update && yum install JamesDSP
If you are still using PulseAudio with your Fedora/openSUSE installation, refer to the 'Build from sources' section below instead.
Build instructions are available in the BUILD.md file.
Since version 2.5.0, this app supports IPC via D-Bus and is also configurable via a CLI.
You can list all supported commands using jamesdsp --help
.
Currently, these commands for remote-controlling JamesDSP's audio engine are available:
--is-connected Check if JamesDSP service is active. Returns exit code 1 if not. (Remote)
--list-keys List available audio configuration keys (Remote)
--get <key> Get audio configuration value (Remote)
--set <key=value> Set audio configuration value (format: key=value) (Remote)
--load-preset <name> Load preset by name (Remote)
--save-preset <name> Save current settings as preset (Remote)
--delete-preset <name> Delete preset by name (Remote)
--list-presets List presets (Remote)
--status Show status (Remote)
--list-devices List audio devices (Remote)
--list-preset-rules List preset rules (Remote)
--set-preset-rule <deviceId=presetName> Add/modify preset rule (Remote)
--delete-preset-rule <deviceId> Delete preset rule (Remote)
The options should be fairly self-explanatory. For example, jamesdsp --set reverb_enable=true
would enable the reverberation setting. Have a look at the audio configuration file at ~/.config/jamesdsp/audio.conf
to learn more about possible setting keys and their syntax.
[!NOTE] These commands try to connect to an active JamesDSP instance. If no instance is currently online, they will fall back to modifying the audio configuration file directly on disk. The
--is-connected
option can be used to check whether one is currently online.
This app also exposes a D-Bus service on the session bus, which can be used by other developers or users:
Service name: me.timschneeberger.jdsp4linux
/jdsp4linux/gui
me.timschneeberger.jdsp4linux.Gui
/jdsp4linux/service
me.timschneeberger.jdsp4linux.Service
If you want to test it out, you can use an app like D-Feet to interact with the D-Bus services.
The D-Bus introspection XML is available here: https://github.com/Audio4Linux/JDSP4Linux/blob/master/src/utils/dbus/manifest.xml.
JamesDSP is randomly killed by the kernel or closes by itself
realtime-priorities
package, add your user to the realtime
group, and re-login. (see issue #155)My volume control is not working anymore
Crackling audio
Tim Schneeberger (ThePBone) 7404 words |
Kazevic 3173 words |
Camellan 3152 words |
Katie Frogs (KatieFrogs) 2944 words |
catvinyl 2352 words |
Choi Jun Hyeong (Gokwu) 2321 words |
Gabriel Cabrera Davila (mefsaal) 652 words |
NullPointerException (seqfault) 1151 words |
mariachini 373 words |
tachyglossues 358 words |
Gustavo Kureck Piccoli (gkpiccoli) 280 words |
Noob Zhang (zhanghua000) 240 words |
kzsuser 221 words |
AnClark Liu (AnClark) 173 words |
Bruh (deproocho) 171 words |
HoleHolo 167 words |
so1ar 126 words |
etiennec79 (etiennec78) 114 words |
James Fung (james34602) 72 words |
theczechczech 42 words |
Alexandre PAIXAO (alex-pex) 30 words |
Joel Tony (jaytau) 28 words |
crisap94 27 words |
Arif Esat Yılmaz (arifesat) 24 words |
Semih Aslan (andmydignity) 15 words |
Robert Abreu (deathrobert2010) 13 words |
Lucas De Paula (ldepaulaf) 11 words |
Mr.Positiv (artemgrebennikov310) 4 words |
Rkchus Qkxhdu (qkxhdurkchus) 3 words |
dev_trace 2 words |
Alfredo Hernandez (alfredo30.herz) 2 words |
SorasTaz (berkantdu123) 2 words |
This project is licensed under GPLv3.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE.