From 083ee3f1dd74441e288b4d63178ae9cea12ba286 Mon Sep 17 00:00:00 2001
From: Jonas L <jooola@users.noreply.github.com>
Date: Wed, 27 Dec 2023 18:23:40 +0100
Subject: [PATCH] feat!: default system output is now `pulseaudio` (#2842)

BREAKING CHANGE: The default system output
(`stream.outputs.system[].kind`) changed from `alsa` to `pulseaudio`.
Make sure to update your configuration file if you rely on the default
system output.

Closes #2542
---
 docker/config.template.yml                | 4 ++--
 docker/config.yml                         | 4 ++--
 docker/example/config.yml                 | 4 ++--
 docs/admin-manual/configuration.md        | 4 ++--
 docs/releases/unreleased.md               | 4 ++++
 installer/config.yml                      | 4 ++--
 legacy/application/configs/conf.php       | 2 +-
 shared/libretime_shared/config/_models.py | 2 +-
 8 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/docker/config.template.yml b/docker/config.template.yml
index ff3ed7824..a970dece1 100644
--- a/docker/config.template.yml
+++ b/docker/config.template.yml
@@ -324,5 +324,5 @@ stream:
         enabled: false
         # System output kind.
         # > must be one of (alsa, ao, oss, portaudio, pulseaudio)
-        # > default is alsa
-        kind: alsa
+        # > default is pulseaudio
+        kind: pulseaudio
diff --git a/docker/config.yml b/docker/config.yml
index e7d14253d..50ed98bc3 100644
--- a/docker/config.yml
+++ b/docker/config.yml
@@ -324,5 +324,5 @@ stream:
         enabled: false
         # System output kind.
         # > must be one of (alsa, ao, oss, portaudio, pulseaudio)
-        # > default is alsa
-        kind: alsa
+        # > default is pulseaudio
+        kind: pulseaudio
diff --git a/docker/example/config.yml b/docker/example/config.yml
index f0c3adbae..07056660e 100644
--- a/docker/example/config.yml
+++ b/docker/example/config.yml
@@ -324,5 +324,5 @@ stream:
         enabled: false
         # System output kind.
         # > must be one of (alsa, ao, oss, portaudio, pulseaudio)
-        # > default is alsa
-        kind: alsa
+        # > default is pulseaudio
+        kind: pulseaudio
diff --git a/docs/admin-manual/configuration.md b/docs/admin-manual/configuration.md
index 814f2f15f..06bca4c39 100644
--- a/docs/admin-manual/configuration.md
+++ b/docs/admin-manual/configuration.md
@@ -529,8 +529,8 @@ stream:
         enabled: false
         # System output kind.
         # > must be one of (alsa, ao, oss, portaudio, pulseaudio)
-        # > default is alsa
-        kind: "alsa"
+        # > default is pulseaudio
+        kind: "pulseaudio"
 ```
 
 ## LDAP
diff --git a/docs/releases/unreleased.md b/docs/releases/unreleased.md
index d9047d6fb..c5fe44f32 100644
--- a/docs/releases/unreleased.md
+++ b/docs/releases/unreleased.md
@@ -30,6 +30,10 @@ Please follow this **before the upgrade procedure**.
 
 The `general.secret_key` field in the [configuration file](../admin-manual/configuration.md#general) is now **required**, to prevent reusing the `general.api_key` for cryptographic usage.
 
+### The `stream.outputs.system[].kind` configuration field now defaults to `pulseaudio`
+
+The `stream.outputs.system[].kind` field in the [configuration file](../admin-manual/configuration.md#general) default value changed from `alsa` to `pulseaudio`. Make sure to update your configuration file if you rely on the default system output.
+
 ## :warning: Known issues
 
 The following issues may need a workaround for the time being. Please search the [issues](https://github.com/libretime/libretime/issues) before reporting problems not listed below.
diff --git a/installer/config.yml b/installer/config.yml
index 9f1bff193..ef0a5893a 100644
--- a/installer/config.yml
+++ b/installer/config.yml
@@ -324,5 +324,5 @@ stream:
         enabled: false
         # System output kind.
         # > must be one of (alsa, ao, oss, portaudio, pulseaudio)
-        # > default is alsa
-        kind: alsa
+        # > default is pulseaudio
+        kind: pulseaudio
diff --git a/legacy/application/configs/conf.php b/legacy/application/configs/conf.php
index 0e18355e9..67dab1555 100644
--- a/legacy/application/configs/conf.php
+++ b/legacy/application/configs/conf.php
@@ -207,7 +207,7 @@ class Schema implements ConfigurationInterface
             // System outputs
             /**/->arrayNode('system')->arrayPrototype()->children()
             /*  */->booleanNode('enabled')->defaultFalse()->end()
-            /*  */->scalarNode('kind')->defaultValue('alsa')
+            /*  */->scalarNode('kind')->defaultValue('pulseaudio')
             /*    */->validate()->ifNotInArray(["alsa", "ao", "oss", "portaudio", "pulseaudio"])
             /*    */->thenInvalid('invalid stream.outputs.system.kind %s')
             /*  */->end()->end()
diff --git a/shared/libretime_shared/config/_models.py b/shared/libretime_shared/config/_models.py
index 737e5b30f..877b3e1ad 100644
--- a/shared/libretime_shared/config/_models.py
+++ b/shared/libretime_shared/config/_models.py
@@ -226,7 +226,7 @@ class SystemOutputKind(str, Enum):
 
 class SystemOutput(BaseModel):
     enabled: bool = False
-    kind: SystemOutputKind = SystemOutputKind.ALSA
+    kind: SystemOutputKind = SystemOutputKind.PULSEAUDIO
 
 
 # pylint: disable=too-few-public-methods