Skip to content
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.

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

Update Installation-for-Linux.md adding PipeWire usage. #980

Merged
merged 37 commits into from
Feb 10, 2024
Merged
Changes from 7 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
9a85f10
Update Installation-for-Linux.md
jujudusud Dec 23, 2023
ca417e7
following ignotus' comments
jujudusud Dec 23, 2023
be55009
Changes wanted by ignotus.
jujudusud Dec 24, 2023
b205aab
Start a jack server automatically.
jujudusud Dec 24, 2023
da76e30
Full stops
jujudusud Dec 24, 2023
9bf507b
Update wiki/en/Installation-for-Linux.md
jujudusud Dec 24, 2023
d37a11b
full stops + directive on how to do.
jujudusud Dec 24, 2023
45faa20
suppress not needed "however".
jujudusud Dec 25, 2023
2de9565
Update Software-Manual.md
jujudusud Dec 26, 2023
7e68865
Update Software-Manual.md
jujudusud Dec 26, 2023
2a0f2a4
Update wiki/en/Installation-for-Linux.md
jujudusud Dec 27, 2023
bf4fb4d
Update wiki/en/Installation-for-Linux.md
jujudusud Dec 27, 2023
3de5a39
Update wiki/en/Installation-for-Linux.md
jujudusud Dec 27, 2023
e70bb25
Update wiki/en/Installation-for-Linux.md
jujudusud Dec 27, 2023
de1e160
Update Installation-for-Linux.md
jujudusud Dec 29, 2023
d1a3fba
adding a link to PipeWire's wiki
jujudusud Dec 29, 2023
d203480
suppress rendez-vous
jujudusud Dec 30, 2023
6f125da
Update wiki/en/Installation-for-Linux.md
jujudusud Dec 30, 2023
87aff02
Update wiki/en/Installation-for-Linux.md
jujudusud Dec 30, 2023
5ef406c
Update wiki/en/Installation-for-Linux.md
jujudusud Dec 30, 2023
ccf8bec
Suppress sound breaking problem sentence
jujudusud Jan 12, 2024
0097700
Setup your harware modifications
jujudusud Jan 12, 2024
f86b1b9
Modifications on how to change the latency
jujudusud Jan 12, 2024
b32a40a
Update wiki/en/Installation-for-Linux.md
jujudusud Jan 14, 2024
c734c59
Update wiki/en/Installation-for-Linux.md
jujudusud Feb 4, 2024
31afd05
Update wiki/en/Installation-for-Linux.md
jujudusud Feb 4, 2024
b727507
Update wiki/en/Installation-for-Linux.md
jujudusud Feb 4, 2024
f29131a
Update wiki/en/Installation-for-Linux.md
jujudusud Feb 4, 2024
c3fdbf9
Update wiki/en/Software-Manual.md
jujudusud Feb 4, 2024
d9601d0
Update wiki/en/Installation-for-Linux.md
jujudusud Feb 6, 2024
dd640e7
Update wiki/en/Installation-for-Linux.md
jujudusud Feb 6, 2024
b313c53
Update wiki/en/Installation-for-Linux.md
jujudusud Feb 6, 2024
a51c236
Update wiki/en/Installation-for-Linux.md
jujudusud Feb 6, 2024
145fd05
Update wiki/en/Installation-for-Linux.md
jujudusud Feb 6, 2024
76d03ae
Update wiki/en/Installation-for-Linux.md
jujudusud Feb 6, 2024
f72527c
Update wiki/en/Installation-for-Linux.md
jujudusud Feb 6, 2024
b86e718
Update wiki/en/Installation-for-Linux.md
jujudusud Feb 10, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 27 additions & 6 deletions wiki/en/Installation-for-Linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,22 +54,43 @@ For installers on other distributions, see their package managers and [Repology]

## Set up your hardware

If no instance of a JACK server is running, one is normally started automatically.
jujudusud marked this conversation as resolved.
Show resolved Hide resolved

Jamulus will attach to a running JACK instance by name, using the `JACK_DEFAULT_SERVER` environment variable or `default` if the variable is not set.
jujudusud marked this conversation as resolved.
Show resolved Hide resolved

If your distribution uses JACK as the sound server, check out [how to configure JACK with QjackCtl](Installation-for-Linux#configure-jack-with-qjackctl).
jujudusud marked this conversation as resolved.
Show resolved Hide resolved

If your distribution uses PipeWire by default, check out the section on [configuring PipeWire](Installation-for-Linux#configure-pipewire).

### Configure JACK with QjackCtl

Jamulus Clients need [JACK](https://jackaudio.org/) to run, but you need to configure that first. The recommended method is to use `QjackCtl`.

1. Launch QjackCtl. You will see the **Qt JACK Control utility main page**
1. Launch QjackCtl. You will see the **Qt JACK Control utility main page**.
2. Configure your audio hardware as follows (the exact settings for JACK will depend on what your audio hardware is capable of):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Configure your audio hardware as follows (the exact settings for JACK will depend on what your audio hardware is capable of):
2. Configure your audio hardware as follows (except where noted):


- Set the audio **Interface** to the one you want (there may be several in the list)
- Set the **Sample Rate to 48000**
- Set the **Frames/Period to 128** and Periods/Buffer at 2 at first
- Set the audio **Interface** to the one you want (there may be several in the list).
jujudusud marked this conversation as resolved.
Show resolved Hide resolved
- Set the **Sample Rate to 48000**.
- Set the **Frames/Period to 128** and Periods/Buffer at 2 at first.
jujudusud marked this conversation as resolved.
Show resolved Hide resolved

Restart JACK for the new settings to take effect
Restart JACK for the new settings to take effect.

### Configure PipeWire

The Jamulus Client requires a JACK sound server (native PipeWire support has not yet been implemented).
PipeWire provides a compatibility layer that emulates the JACK server, so when you launch the Jamulus Client, however PîpeWire automatically exposes itself to it as a JACK server.
jujudusud marked this conversation as resolved.
Show resolved Hide resolved
You need to set your audio interface to the "pro-audio" profile and define PipeWire's "rate" and "quantum" parameters beforehand.
To do so, follow these steps:
1. open `pavucontrol` (the audio mixer) and choose the "pro-audio" profile in the configuration tab,
jujudusud marked this conversation as resolved.
Show resolved Hide resolved
2. In a terminal use the two following commands:
```bash
pw-metadata -n settings 0 clock.force-rate 48000
pw-metadata -n settings 0 clock.force-quantum 128
```
jujudusud marked this conversation as resolved.
Show resolved Hide resolved

### Start Jamulus

With JACK running and configured, launch Jamulus.
With JACK or PipeWire configured, launch Jamulus.

If you get problems with sound breaking up (in particular XRUN errors reported by JACK/QjackCtl) try setting bigger values (e.g. 256 frames or 3 periods). Lower ones (e.g. 64 frames) could bring better performance but maybe more sound problems. See the [troubleshooting page](Client-Troubleshooting) otherwise.
jujudusud marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
Loading