Merge pull request '1.1.0 release' (#2) from feature/release_prepare into main

Reviewed-on: http://10.10.1.170:30008/buggex/streamcontroller_soundboard/pulls/2

Author: buggex

LICENSE

@@ -2,20 +2,8 @@ MIT License
 
 Copyright (c) 2025 Buggex
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

__install__.py

@@ -2,4 +2,4 @@
 from os.path import join, abspath, dirname
 
 toplevel = dirname(abspath(__file__))
-create_venv(join(toplevel, ".venv"), join(toplevel, "assets", "requirements.txt"))
+create_venv(join(toplevel, "backend", ".venv"), join(toplevel, "backend", "requirements.txt"))

actions/PlayAction/PlayAction.py actions/playaction/playaction.pyactions/PlayAction/PlayAction.py renamed to actions/playaction/playaction.py

@@ -4,7 +4,7 @@
 from src.backend.PluginManager.InputBases import ActionCore
 
 # Helpers
-from com_buggex_sc_soundboard.helpers import Consts
+from com_buggex_soundboard.helpers import Consts
 
 # Import gtk modules - used for the config rows
 import gi
@@ -33,7 +33,8 @@ def get_config_rows(self) -> list:
         self.load_config_values()
 
         self.ui_sound_path = PathRow(self)
-        self.ui_sound_path.label.set_label(self.sound_path)
+        if self.sound_path:
+            self.ui_sound_path.label.set_label(self.sound_path)
 
         self.ui_volume = Adw.SpinRow.new_with_range(min=0, max=100, step=1)
         self.ui_volume.set_title(self.plugin_base.lm.get("actions.play.volume.title"))

actions/StopAction/StopAction.py actions/stopaction/stopaction.pyactions/StopAction/StopAction.py renamed to actions/stopaction/stopaction.py

@@ -1,9 +1,23 @@
 {
     "generic": {
-        "copyright": "",
-        "original-url": "",
-        "license": "",
-        "license-url": "",
+        "copyright": "BuggeX",
+        "original-url": "https://github.com/buggex/StreamController-SoundboardPlugin",
+        "license": "MIT",
+        "license-url": "https://opensource.org/licenses/MIT",
         "description": ""
+    },
+    "assets/stop.png": {
+        "copyright": "Google",
+        "original-url": "https://github.com/google/material-design-icons",
+        "license": "Apache-2.0",
+        "license-url": "https://www.apache.org/licenses/LICENSE-2.0.html",
+        "description": ""
+    },
+    "assets/Thumbnail.png": {
+        "copyright": "Google",
+        "original-url": "https://github.com/google/material-design-icons",
+        "license": "Apache-2.0",
+        "license-url": "https://www.apache.org/licenses/LICENSE-2.0.html",
+        "description": "Thumbnail partial made with google fonts."
     }
 }

assets/Attribution.txt

@@ -1,56 +1,61 @@
 from streamcontroller_plugin_tools import BackendBase
 
-import vlc
-import time
+from player_interface import PlayerInterface
+from player_pygame import PlayerPygame
+from player_vlc import PlayerVLC
 
 from loguru import logger as log
 
-PLAY_WAIT_TIME_SECONDS = 0.05
-MAX_PLAY_WAIT_TRIES = int(1 / PLAY_WAIT_TIME_SECONDS)
+import pygame
+import pygame._sdl2.audio as sdl2_audio
+
+# To get access to plugin files
+import sys
+from pathlib import Path
+ABSOLUTE_PLUGIN_PATH = str(Path(__file__).parent.parent.absolute())
+sys.path.insert(0, ABSOLUTE_PLUGIN_PATH)
+
+from helpers import Consts
+from helpers.Consts import Players
 
 class SoundboardBackend(BackendBase):
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
+    player : PlayerInterface
+
+    def __init__(self):
+        super().__init__()
         self.device = ""
-        self.instance = vlc.Instance()
         self.player = None
 
+    def set_player(self, playerType):
+        player = Consts.PLAYER_NAMES[playerType]
+        log.debug(f"new player: {playerType}")
+        match player:
+            case Players.Pygame:
+                self.player = PlayerPygame()
+            case Players.libVLC:
+                self.player = PlayerVLC()
+            case _:
+                log.error(f"Unknown playerType {playerType} {player}")
+
+        if self.player is not None:
+            self.player.set_device(self.device)
+
     def set_device(self, device):
         self.device = device
+        if self.player is not None:
+            self.player.set_device(device)
 
-    def play_sound(self, path_to_sound, volume=100):
-        # Stop old
-        self.stop_sound()
-
-        # Start new
-        media = self.instance.media_new("file://" + path_to_sound)
-        self.player = media.player_new_from_media()
-        self.player.audio_output_device_set(None, self.find_device(self.player, self.device))
-        r = self.player.play()
-        if r == 0:
-            # We need for playback to begin before we can set volume
-            # TODO: Need to find a better solution
-            tries = 0
-            while self.player.is_playing() is 0 and tries < MAX_PLAY_WAIT_TRIES:
-                time.sleep(PLAY_WAIT_TIME_SECONDS)
-                tries += 1
-            self.player.audio_set_volume(int(volume))
-        else:
-            log.error(f"Failed to play. File: {path_to_sound}")
+    def play_sound(self, path_to_sound, volume):
+        if self.player is not None:
+            self.player.play_sound(path_to_sound, volume)
 
     def stop_sound(self):
-        if self.player:
-            self.player.release()
-
-    def find_device(self, player, device_name):
-        devices = player.audio_output_device_enum()
-        if devices:
-            device = devices
-            while device:
-                device = device.contents
-                if device_name in str(device.description):
-                    return device.device
-                device = device.next
-        return None
-
-backend = SoundboardBackend()
+        if self.player is not None:
+            self.player.stop_sound()
+
+    def get_audio_devices(self):
+        if not pygame.mixer.get_init():
+            pygame.mixer.init()
+        return sdl2_audio.get_audio_device_names(False)
+
+backend = SoundboardBackend()

assets/Thumbnail.png

@@ -0,0 +1,16 @@
+from abc import ABC, abstractmethod
+
+# creating interface
+class PlayerInterface(ABC):
+
+    @abstractmethod
+    def set_device(self, device):
+       pass
+
+    @abstractmethod
+    def play_sound(self, path_to_sound, volume):
+        pass
+
+    @abstractmethod
+    def stop_sound(self):
+        pass