Pipewire: added a guide on virtual microphone

Added a section on problems that occur for loopback devices in combination with EasyEffects default configuration.

wiki/linux/easyeffects.md

@@ -35,6 +35,15 @@ It is then displayed in the list below from where it can be loaded or deleted.
 Presets are saved in the directory `~/.config/easyeffects/input` and
 `~/.config/easyeffects/output`.
 
+### Process All Input and Output Streams
+
+By default, EasyEffects processes all input and output streams.
+This includes [loopback devices](/wiki/linux/pipewire.md#virtual-devices) with which it may lead to
+some problems - for example
+[problems with virtual devices](/wiki/linux/pipewire.md#problems-with-input-an-output-of-loopback-devices).
+It can be disabled and re-enabled in the `Preferences` under `Audio` by deselecting or selecting the
+switches for `Process all output streams` and `Process all input streams`.
+
 #### Recommended Presets
 
 The following is a list of presets that have been tested and only need slight configuration to

wiki/linux/pipewire.md

@@ -18,14 +18,14 @@ Make sure to restart to be sure everything is running correctly.
 Pipewire has a few config files.
 The needed folder structure can be created by the following command for a global setup.
 
-```sh 
+```sh
-sudo mkdir -p /etc/pipewire/ && sudo mkdir -p /etc/wireplumber/wireplumber.conf.d/ && sudo cp /usr/share/pipewire/*.conf /etc/pipewire/ && sudo cp /usr/share/wireplumber/wireplumber.conf.d/* /etc/wireplumber/wireplumber.conf.d/ 
+sudo mkdir -p /etc/pipewire/ && sudo mkdir -p /etc/wireplumber/wireplumber.conf.d/ && sudo cp /usr/share/pipewire/*.conf /etc/pipewire/ && sudo cp /usr/share/wireplumber/wireplumber.conf.d/* /etc/wireplumber/wireplumber.conf.d/
 ```
 
 It can also be done locally for the user with the following, alternative setup.
 
-```sh 
+```sh
-mkdir -p ~/.config/pipewire/ && mkdir -p ~/.config/wireplumber/wireplumber.conf.d/ && cp /usr/share/pipewire/*.conf ~/.config/pipewire/ && cp /usr/share/wireplumber/wireplumber.conf.d/* ~/.config/wireplumber/wireplumber.conf.d/ 
+mkdir -p ~/.config/pipewire/ && mkdir -p ~/.config/wireplumber/wireplumber.conf.d/ && cp /usr/share/pipewire/*.conf ~/.config/pipewire/ && cp /usr/share/wireplumber/wireplumber.conf.d/* ~/.config/wireplumber/wireplumber.conf.d/
 ```
 
 ## Usage
@@ -91,11 +91,17 @@ pw-loopback -C <id>
 This section focusses on the temporary and permanent creation and removal of virtual devices like
 virtual sinks and sources aswell as coupled nodes like loopbacks.
 
-#### Creating a Null Device
+Please note that problems may occur if [EasyEffects](/wiki/linux/easyeffects.md) is used in
+combination with virtual devices.
+This mostly is based upon standard configuration.
+Most importantly stream devices may have problems as explained in the
+[corresponding section](#problems-with-input-an-output-of-loopback-devices).
 
-This section will focus on the creation of a dummy device.
+#### Creating a Virtual Sinks
+
+This section will focus on the creation of a virtual sink.
 That is a virtual device that can be selected as output but is not used by default.
-This can be useful to record applications as their sound can cleanly be passed to the dummy device
+This can be useful to record applications as their sound can cleanly be passed to the virtual sink
 which will eliminate other applications sounds.
 If the goal is to record and listen to an application at the same time navigate to
 [the application loopback section](#creating-an-application-loopback)
@@ -103,7 +109,7 @@ If the goal is to record and listen to an application at the same time navigate
 The source for this section of the entry is derived by
 [Pipewire Gitlab site](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Virtual-Devices#single-nodes).
 
-A dummy device, or null sink, can be created permanently by creating a `.conf` file inside the
+A virtual sink can be created permanently by creating a `.conf` file inside the
 `~/.config/pipewire/pipewire.conf.d` directory with the following lines.
 
 
@@ -112,8 +118,8 @@ context.objects = [
     {   factory = adapter
         args = {
             factory.name     = support.null-audio-sink
-            node.name        = "null-sink-0"
+            node.name        = "virtual-sink-0"
-            node.description = "Null Sink 0"
+            node.description = "Virtual Sink 0"
             media.class      = Audio/Sink
             audio.position   = [ FL FR ]
             monitor.channel-volumes = true
@@ -132,15 +138,17 @@ Multiple devices can be created by creating different files in the directory.
 
 If the null sink is only needed temporarily (until the next restart) the following line can be used
 to create it.
-Use different `sink_name`s to create multiple dummy devices.
+To create multiple virtual sinks different values for the name of the sink have to be used.
+In the following example `<sink-name>` is a placeholder for the name of the sink.
 
 ```sh
-pactl load-module module-null-sink media.class=Audio/Sink sink_name=null-sink-0 channel_map=stereo
+pactl load-module module-null-sink media.class=Audio/Sink sink_name=<sink-name> channel_map=stereo
 ```
 
-This will return an id that can be used to remove the sink with the following command.
+This will return an ID that can be used to remove the sink with the following command.
+`<id>` is the placeholder for the ID.
 
-```sh 
+```sh
 pactl unload-module <id>
 ```
 
@@ -166,12 +174,12 @@ context.modules = [
       capture.props = {
         media.class = "Stream/Input/Audio"
         node.name = "device-loopback-1-recording"
-        node.description = "Device-Loopback 1 Recording"
+        node.description = "Device Loopback 1 Recording"
       }
       playback.props = {
         media.class = "Stream/Output/Audio"
         node.name = "device-loopback-1-playback"
-        node.description = "Device-Loopback 1 Playback"
+        node.description = "Device Loopback 1 Playback"
       }
       audio.volume = 0.5
       audio.mute = true
@@ -186,7 +194,7 @@ The part called `Device-Loopback 1 Recording` in the example config can be found
 tab.
 There the device to loopback can be selected.
 The second part called `Device-Loopback 1 Playback` is available under the `Playback` tab and
-allows to switch the selection of the output device.
+allows switching the selection of the output device.
 
 #### Creating an Application Loopback
 
@@ -195,7 +203,7 @@ In this section an application loopback is defined as a loopback that takes an a
 This can be useful to record applications as their sound can cleanly be passed to the sink sink of
 the applicatino loopback which will eliminate other applications sounds.
 If the goal is to record and not listen to the application at the same time navigate to
-[the null device section](#creating-a-null-device).
+[the null device section](#creating-a-virtual-sinks).
 Alternatively the null device can also be selected as a output device for the playback part of the
 application loopback which makes it easily and seemlessly possible to switch between listening in
 and not listening without changing the device that is recorded by the capturing program.
@@ -207,7 +215,7 @@ and [the official website](https://docs.pipewire.org/page_module_loopback.html).
 An application loopback can be created permanently by creating a `.conf` file inside the
 `~/.config/pipewire/pipewire.conf.d` directory with the following lines.
 
-```txt 
+```txt
 context.modules = [{
     name = libpipewire-module-loopback
     args = {
@@ -215,12 +223,12 @@ context.modules = [{
         capture.props = {
             media.class = "Audio/Sink"
             node.name = "application-loopback-1-sink"
-            node.description = "Application-Loopback 1 Sink"
+            node.description = "Application Loopback 1 Sink"
         }
         playback.props = {
             media.class = "Stream/Output/Audio"
             node.name = "application-loopback-1-playback"
-            node.description = "Application-Loopback 1 Playback"
+            node.description = "Application Loopback 1 Playback"
         }
     }
 }]
@@ -231,14 +239,70 @@ mixer like [pavucontrol](#volume-control).
 The part called `Application-Loopback 1 Sink` in the example config can be found in the `Output
 Devices` tab.
 The second part called `Application-Loopback 1 Playback` is available under the `Playback` tab and
-allows to switch the selection of the output device.
+allows switching the selection of the output device.
 Also in the `Playback` tab `Application-Loopback 1 Sink` can be selected as an output for currently
 running applications which will loopback the sound to the selected output device.
 
+#### Creating Virtual Sources
+
+This section will focus on the creation of a virtual source.
+That is a virtual device that can be selected as input but is not used by default.
+This can be useful to pass sound to a program that only accepts microphones by default.
+If different sources have to be bundled first an application loopback can be used.
+A guide on the creation of it is in
+[the application loopback section](#creating-an-application-loopback).
+
+A virtual source can be created permanently by creating a `.conf` file inside the
+`~/.config/pipewire/pipewire.conf.d` directory with the following lines.
+
+
+```txt
+context.modules = [
+  {
+    name = libpipewire-module-loopback
+    args = {
+      audio.position = [ FL FR ]
+
+      capture.props = {
+        media.class = "Stream/Input/Audio"
+        node.name = "virtual-source-1-recording"
+        node.description = "Virtual Source 1 Recording"
+      }
+
+      playback.props = {
+        media.class = "Audio/Source"
+        node.name = "virtual-source-1-source"
+        node.description = "Virtual Source 1 Source"
+      }
+    }
+  }
+]
+```
+
+Multiple devices can be created by creating different files in the directory.
+
+The created virtual source is made up by two parts that can be found in different places inside a
+mixer like [pavucontrol](#volume-control).
+The part called `Virtual Source 1 Source` in the example config can be found in the `Input Devices`
+tab.
+The second part called `Virtual Source 1 Recording` is available under the `Recording` tab and
+allows switching the selection of the output or input to feed into the virtual microphone.
+
 ## Troubleshooting
 
 This section will focus on errors and the fixing of errors of Pipewire.
 
+### Problems with Input an Output of Loopback Devices
+
+If the input and output of devices of the types `Stream/Output/Audio` and `Stream/Input/Audio`
+automatically switches back to [EasyEffects](/wiki/linux/easyeffects.md) then EasyEffects is not
+configured correctly to use with such devices.
+This also can lead to problems with using [loopback](#loopback-input) and other
+[virtual devices](#virtual-devices).
+It can easily be fixed by not processing inputs and outputs automatically.
+This is described in depth
+[the corresponding section of the EasyEffects entry](/wiki/linux/easyeffects.md#process-all-input-and-output-streams).
+
 ### Fix Crackling
 
 Crackling can occur in various situations.
@@ -250,12 +314,12 @@ In `alsa-vm.conf` the `suspend_timeout_seconds` have to be set to `0` like the f
 show.
 This also shows the general structure but only the line starting with `session` is to be added.
 
-```txt 
+```txt
 
 monitor.alsa.rules = [
-  { 
+  {
-    actions = { 
+    actions = {
-      update-props = { 
+      update-props = {
         session.suspend-timeout-seconds = 0
   }
 ]
@@ -264,13 +328,13 @@ monitor.alsa.rules = [
 Another possibility for crackling to occur is when the allowed rates are mismatched.
 In `pipewire.conf` locate the following line.
 
-```txt 
+```txt
 #default.clock.allowed-rates = [ 48000 ]
 ```
 
 Change this line to look like the following.
 
-```txt 
+```txt
 default.clock.allowed-rates = [ 44100 48000 ]
 ```
 
@@ -283,7 +347,7 @@ api.alsa.headroom      = 2048
 
 Change it to look like the following line.
 
-```txt 
+```txt
 api.alsa.headroom      = 0
 ```
 
@@ -298,7 +362,7 @@ api.alsa.period-size   = 1024
 
 Change it to look like the following line.
 
-```txt 
+```txt
 api.alsa.period-size   = 256
 ```