Using JACK and PipeWire - Revision history

Gnif at 02:05, 9 November 2024

2024-11-09T02:05:42Z

162.158.146.103: /* Allow QEMU user access to your PipeWire socket */

2024-05-25T08:40:50Z

Allow QEMU user access to your PipeWire socket

172.71.98.91 at 14:30, 28 April 2024

2024-04-28T14:30:27Z

172.69.90.105: /* Run VMs under your user */

2024-03-27T00:17:28Z

Run VMs under your user

172.70.105.146: Add information on how to get it to work in NixOS

2022-07-30T19:51:30Z

Add information on how to get it to work in NixOS

172.70.85.30: Add example for the connectPorts property

2022-06-26T19:27:05Z

Add example for the connectPorts property

172.70.85.30: Update Arch installation notes.

2022-06-26T19:25:22Z

Update Arch installation notes.

Quantum: qemu 6.1 is now in official backports

2021-10-31T12:13:43Z

qemu 6.1 is now in official backports

Netboy3: /* Allow QEMU user access to your PipeWire socket */

2021-10-20T19:12:41Z

Allow QEMU user access to your PipeWire socket

Quantum at 09:05, 12 October 2021

2021-10-12T09:05:03Z

← Older revision		Revision as of 02:05, 9 November 2024
Line 1:		Line 1:
	__FORCETOC__		__FORCETOC__
		+
		+	----
		+
		+	'''NOTE: Since the release of Looking Glass B6 which has native audio support built in, this is no longer the preferred method unless you require audio from the VM while the LG client application is not running'''
		+
		+	----
		+
	QEMU's JACK backend provides the best audio quality out of all the available options (Scream, PulseAudio, etc.). One of the easiest ways to leverage the JACK support is by using PipeWire, which emulates JACK.		QEMU's JACK backend provides the best audio quality out of all the available options (Scream, PulseAudio, etc.). One of the easiest ways to leverage the JACK support is by using PipeWire, which emulates JACK.

@@ Line 45: / Line 45: @@
 Once you shutdown your VM and restart it, you should see an emulated HD audio device, and any sound should go into PipeWire. If you don't hear anything, check your patchbay connections.
-== Allow QEMU user access to your PipeWire socket ==
+== Allow QEMU user access your PipeWire socket ==
 We will assuming your username is <code>example</code>, your user ID is 1000, and your virtual machine is called <code>win10</code>. We will also assume the QEMU user is <code>libvirt-qemu</code>, but this varies based on distro. We will be duplicating the socket as <code>/srv/win10/pipewire-0</code>, but the directory can be changed.

@@ Line 21: / Line 21: @@
 Then, you can run <code>virsh edit win10</code>, and perform the following changes:
-# If the <code><domain></code> line doesn't already contain <code>xmlns:qemu</code>, add <code><
+# If the <code><domain></code> line doesn't already contain <code>xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'</code>, add it.
 #: If there is an existing <code><sound></code> block, it should be removed.
 # Finally, we need to set PipeWire's runtime directory and latency. These are configured by environment variables. To do this, the following block right before <code></domain></code>:

@@ Line 21: / Line 21: @@
 Then, you can run <code>virsh edit win10</code>, and perform the following changes:
-# If the <code><domain></code> line doesn't already contain <code>xmlns:qemu</code>, add <code><nowiki>xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'</nowiki></code>. The line should look like:
+# If the <code><domain></code> line doesn't already contain <code>xmlns:qemu</code>, add <code><
 #: If there is an existing <code><sound></code> block, it should be removed.
 # Finally, we need to set PipeWire's runtime directory and latency. These are configured by environment variables. To do this, the following block right before <code></domain></code>:
@@ Line 52: / Line 40: @@
 </source>
-If you are using NixOS, you'll also need to add <code><qemu:env name="LD_LIBRARY_PATH" value="$LD_LIBRARY_PATH:/run/current-system/sw/lib/pipewire"/></code> to your <code><qemu:commandline></code> section.
 Once you shutdown your VM and restart it, you should see an emulated HD audio device, and any sound should go into PipeWire. If you don't hear anything, check your patchbay connections.

@@ Line 51: / Line 51: @@
    /run/user/1000/pipewire-0 rw,
 </source>
 Once you shutdown your VM and restart it, you should see an emulated HD audio device, and any sound should go into PipeWire. If you don't hear anything, check your patchbay connections.
@@ Line 114: / Line 116: @@
    /srv/win10/pipewire-0 rw,
 </source>
 Once you shutdown your VM and restart it, you should see an emulated HD audio device, and any sound should go into PipeWire. If you don't hear anything, check your patchbay connections.

@@ Line 33: / Line 33: @@
    </sound>
 </syntaxhighlight>
-#: <code>input-name</code> and <code>output-name</code> should be replaced with a regular expression that matches the name of the JACK input and output ports. Essentially, these are the names of microphone and speaker devices that the VM would connect to. You can get the names by looking at your patchbay, or run <code>jack_lsp</code>.
+#: <code>input-name</code> and <code>output-name</code> should be replaced with a regular expression that matches the name of the JACK input and output ports, for example <code>connectPorts='Built-in Audio Analog Stereo:playback_F[LR]'</code>. Essentially, these are the names of microphone and speaker devices that the VM would connect to. You can get the names by looking at your patchbay, or run <code>jack_lsp</code>.
 #: If there is an existing <code><sound></code> block, it should be removed.
 # Finally, we need to set PipeWire's runtime directory and latency. These are configured by environment variables. To do this, the following block right before <code></domain></code>:

@@ Line 7: / Line 7: @@
 Normally, you can run applications with PipeWire's JACK support by running it with <code>pw-jack</code>, but this is not possible when using libvirt. Instead, you need PipeWire to provide drop-in JACK support. To do this:
 * on Debian: run <code>sudo cp /usr/share/doc/pipewire/examples/ld.so.conf.d/pipewire-jack-*.conf /etc/ld.so.conf.d/; sudo ldconfig</code>
-* on Arch: install the [https://aur.archlinux.org/packages/pipewire-jack-dropin/ pipewire-jack-dropin] AUR package.
+* on Arch: install the <code>qemu-audio-jack</code> package, which contains the jack driver for qemu, and the <code>pipewire-jack</code> package.
 Once this is done, you have two options. You could run your virtual machines under your user, or you could set it up so that the QEMU user has access to your PipeWire socket. The former is easier, while the latter is more secure.

@@ Line 3: / Line 3: @@
 First, you must make sure your distro's QEMU is built with JACK support:
-* On Debian, this is not the case until QEMU 6.1. This is currently only in unstable. In the meantime, you can use [https://apt.quantum2.xyz/qemu-jack/ this repository].
+* On Debian, this is not the case until QEMU 6.1. This is currently only in unstable and bullseye-backports. You should enable backports if you are using bullseye and upgrade if you are using something older.
 Normally, you can run applications with PipeWire's JACK support by running it with <code>pw-jack</code>, but this is not possible when using libvirt. Instead, you need PipeWire to provide drop-in JACK support. To do this:

@@ Line 65: / Line 65: @@
 $ chmod 700 /srv/win10
 $ setfacl -m u:libvirt-qemu:rx /srv/win10
 </syntaxhighlight>

@@ Line 29: / Line 29: @@
      <output clientName="win10" connectPorts="output-name"/>
    </audio>
 </syntaxhighlight>
-#: <code>input-name</code> and <code>output-name</code> should be replaced with a regular expression that matches the name of the JACK input and output ports. You can get the names by looking at your patchbay, or run <code>jack_lsp</code>.
+#: <code>input-name</code> and <code>output-name</code> should be replaced with a regular expression that matches the name of the JACK input and output ports. Essentially, these are the names of microphone and speaker devices that the VM would connect to. You can get the names by looking at your patchbay, or run <code>jack_lsp</code>.
 # Finally, we need to set PipeWire's runtime directory and latency. These are configured by environment variables. To do this, the following block right before <code></domain></code>:
 #: <syntaxhighlight lang="xml">
@@ Line 87: / Line 91: @@
      <output clientName="win10" connectPorts="output-name"/>
    </audio>
 </syntaxhighlight>
-#: <code>input-name</code> and <code>output-name</code> should be replaced with a regular expression that matches the name of the JACK input and output ports. You can get the names by looking at your patchbay, or run <code>jack_lsp</code>.
+#: <code>input-name</code> and <code>output-name</code> should be replaced with a regular expression that matches the name of the JACK input and output ports. Essentially, these are the names of microphone and speaker devices that the VM would connect to. You can get the names by looking at your patchbay, or run <code>jack_lsp</code>.
 # Finally, we need to set PipeWire's runtime directory and latency. These are configured by environment variables. To do this, the following block right before <code></domain></code>:
 #: <syntaxhighlight lang="xml">