<h1 align="center"> <img alt="Icon" width="75" src="https://github.com/Audio4Linux/JDSP4Linux/blob/master/resources/icons/icon.png?raw=true"> <br> JamesDSP for Linux <br> </h1> <h4 align="center">Open-source sound effects for PipeWire and PulseAudio</h4> <p align="center"> <a href="https://github.com/Audio4Linux/JDSP4Linux/releases"> <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/Audio4Linux/JDSP4Linux"> </a> <a href="https://github.com/Audio4Linux/JDSP4Linux/blob/master/LICENSE"> <img alt="License" src="https://img.shields.io/github/license/Audio4Linux/JDSP4Linux"> </a> <a href="https://github.com/Audio4Linux/JDSP4Linux/"> <img alt="Windows build" src="https://img.shields.io/github/repo-size/Audio4Linux/JDSP4Linux"> </a> </p> <p align="center"> <a href="#features">Features</a> • <a href="#installation">Installation</a> • <a href="#scripting--ipc-apis">Scripting/API</a> • <a href="#contributors">Contributors</a> • <a href="#license">License</a> </p> <p align="center"> <img alt="Screenshot" width="702" src="https://github.com/Audio4Linux/JDSP4Linux/blob/master/meta/screenshot.png?raw=true"> </p> <p align="center"> Linux port developed by <a href="https://github.com/thepbone">Tim Schneeberger (@thepbone)</a> <p/><p align="center"> <a href="https://github.com/james34602/JamesDSPManager">JamesDSP</a> was initially published as an audio effects processor<br>for Android devices and is written by <a href="https://github.com/james34602">James Fung (@james34602)</a>. </p> <p align="center"> Feel free to join our <a href="https://t.me/joinchat/FTKC2A2bolHkFAyO-fuPjw">Telegram group</a> for support and updates </p>

<p align="center"> <a href="https://crowdin.com/project/jdsp4linux" rel="nofollow"><img style="width:140;height:40px" src="https://badges.crowdin.net/badge/light/crowdin-on-dark.png" srcset="https://badges.crowdin.net/badge/light/crowdin-on-dark.png 1x,https://badges.crowdin.net/badge/light/crowdin-on-dark@2x.png 2x" alt="Crowdin" /></a> <br/> Please help us to <a href="https://crowdin.com/project/jdsp4linux">translate this app</a> on <a href="https://crowdin.com/project/jdsp4linux">Crowdin</a>! </p>

Features

Automatic bass boost
- Frequency-detecting bass-boost. Automatically sets its own parameters, such as gain, bandwidth, and cut-off frequency, by analyzing the incoming audio stream
Automatic dynamic range compressor
- A highly automated multiband dynamic range adjusting effect
Complex reverberation IIR network (Progenitor 2)
Interpolated FIR equalizer with flexible bands
Arbitrary response equalizer (also known as GraphicEQ from EqualizerAPO)
- AutoEQ database integration (requires network connection)
Partitioned convolver (Auto segmenting convolution)
- Supports mono, stereo, full/true stereo (LL, LR, RL, RR) impulse response
Crossfeed
- Realistic surround effects
Soundstage wideness
- A multiband stereo wideness controller
ViPER-DDC
- Perform parametric equalization on audio
- Create VDC input files using thepbone/DDCToolbox
Analog modeling
- An aliasing-free even harmonic generator
Output limiter
Scripting engine: Live programmable DSP
- Write your own audio effects using the EEL2 scripting language
- Auto-generate a basic user interface for your script to modify specific parameters/constants without editing the actual code
- The scripting language has been extended using many DSP-related functions for easy access, for example, spectral processing, constant Q transform, multi-purpose FIR filter designer IIR sub-bands transformation, etc...
- This app also includes a custom minimal scripting IDE:
  - Syntax highlighting
  - Basic code completion
  - Dynamic code outline window
  - Console output support
  - Detailed error messages with inline code highlighting

PipeWire vs PulseAudio

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.

Which one am I using?

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

Installation

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.

Installation for PipeWire

This section is dedicated to systems using PipeWire as the audio server. If you are still using PulseAudio, please go here.

Flatpak
Arch Linux (AUR)
Fedora/openSUSE
Build from sources

Flatpak

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.

Arch

AUR packages are available:

Stable version
```
yay -S jamesdsp
```
Development version
```
yay -S jamesdsp-git
```

Fedora/openSUSE

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 from sources

Build instructions are available in the BUILD.md file.

Scripting & IPC APIs

Since version 2.5.0, this app supports IPC via D-Bus and is also configurable via a CLI.

Remote control via 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.

D-Bus IPC

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.jdsp

JDSP4Linux

Install / Use

README