Add Audio Support to the GUI Framework

README.md

@@ -71,12 +71,12 @@ Note that LEADS requires **Python >= 3.12**. To set up the environment on a Rasp
 command, see [Environment Setup](#environment-setup).
 
 ```shell
-pip install Pillow customtkinter pynput pyserial lgpio gpiozero pynmea2 leads
+pip install Pillow PySDL2 customtkinter gpiozero lgpio pynmea2 pynput pyserial leads
 ```
 
 `numpy` and `pandas` will be automatically installed with `leads`.
 
-`Pillow`, `customtkinter`, `pynput`, `pyserial`, `lgpio`, `gpiozero`, and `pynmea2` are optional.
+`Pillow`, `PySDL2`, `customtkinter`, `gpiozero`, `lgpio`, `pynmea2`, `pynput`, and `pyserial` are optional.
 
 If you only want the framework, run the following.
 

leads_audio/__init__.py

@@ -0,0 +1,6 @@
+from importlib.util import find_spec as _find_spec
+
+if not _find_spec("sdl2"):
+    raise ImportError("Please install `PySDL2` to run this module\n>>>pip install PySDL2")
+
+from leads_audio.prototype import *

leads_audio/prototype.py

@@ -0,0 +1,44 @@
+from atexit import register as _register
+
+from sdl2 import AUDIO_S16 as _AUDIO_S16
+from sdl2.sdlmixer import Mix_Init as _init, Mix_OpenAudioDevice as _open_audio_device, MIX_INIT_MP3 as _MIX_INIT_MP3, \
+    Mix_LoadMUS as _load_music, Mix_PlayMusic as _play_music, Mix_Music as _Music, \
+    Mix_GetError as _get_error, Mix_FreeMusic as _free_music, Mix_CloseAudio as _close_audio
+
+from leads_audio.system import _ASSETS_PATH
+
+
+def _ensure(flag: int) -> None:
+    if flag < 0:
+        raise RuntimeError(_get_error().decode())
+
+
+_init(_MIX_INIT_MP3)
+_ensure(_open_audio_device(44100, _AUDIO_S16, 2, 2048, b"System", 1))
+
+
+@_register
+def _release_resources() -> None:
+    _close_audio()
+
+
+class _SoundEffect(object):
+    def __init__(self, name: str) -> None:
+        self._name: str = name
+        self._source: _Music | None = None
+
+    def load_source(self) -> _Music:
+        if self._source is None:
+            self._source = _load_music(f"{_ASSETS_PATH}/{self._name}.mp3".encode())
+        return self._source
+
+    def play(self) -> None:
+        _ensure(_play_music(self.load_source(), 1))
+
+    def stop(self) -> None:
+        _ensure(_free_music(self.load_source()))
+
+
+DIRECTION_INDICATOR_ON: _SoundEffect = _SoundEffect("direction-indicator-on")
+DIRECTION_INDICATOR_OFF: _SoundEffect = _SoundEffect("direction-indicator-off")
+WARNING: _SoundEffect = _SoundEffect("warning")

leads_audio/system.py

@@ -0,0 +1,3 @@
+from os.path import abspath as _abspath
+
+_ASSETS_PATH: str = f"{_abspath(__file__)[:-9]}assets"

setup.py

@@ -16,6 +16,7 @@
     url="https://github.com/ProjectNeura/LEADS",
     packages=find_packages(),
     package_data={
+        "leads_audio": ["assets/*"],
         "leads_gui": ["assets/*", "assets/icons/*"],
         "leads_vec": ["_bootloader/leads_vec.service.sh"]
     },