Fix CI regressions

SDL_CommonEvent and others needed to be marked as packed/flexible

Closing audio streams atexit seems to cause race conditions

Remove outdated Sphinx directives

Check if audio devices work before testing them

Author: HexDecimal

build_sdl.py

@@ -51,6 +51,8 @@
     "SDL_TouchFingerEvent",
     "SDL_MultiGestureEvent",
     "SDL_DollarGestureEvent",
+    "SDL_CommonEvent",
+    "SDL_DisplayEvent",
 )
 
 # Other defined names which sometimes cause issues when parsed.

docs/sdl/joystick.rst

@@ -3,9 +3,3 @@ SDL Joystick Support ``tcod.sdl.joystick``
 
 .. automodule:: tcod.sdl.joystick
     :members:
-    :exclude-members:
-        Power
-
-.. autoclass:: tcod.sdl.joystick.Power
-    :members:
-    :member-order: bysource

tcod/sdl/audio.py

@@ -37,7 +37,6 @@
 
 from __future__ import annotations
 
-import atexit
 import contextlib
 import enum
 import sys
@@ -483,14 +482,6 @@ class AudioStreamCallbackData:
 _audio_stream_registry: weakref.WeakValueDictionary[int, AudioStream] = weakref.WeakValueDictionary()
 
 
-@atexit.register
-def _unlink_audio_callbacks() -> None:
-    """Deletes AudioStream callbacks to ensure a graceful application exit."""
-    for stream in _audio_stream_registry.values():
-        stream.getter_callback = None
-        stream.putter_callback = None
-
-
 class AudioStream:
     """An SDL audio stream.
 
@@ -674,11 +665,13 @@ def getter_callback(self) -> Callable[[AudioStream, AudioStreamCallbackData], An
     @getter_callback.setter
     def getter_callback(self, callback: Callable[[AudioStream, AudioStreamCallbackData], Any] | None, /) -> None:
         if callback is None:
-            lib.SDL_SetAudioStreamGetCallback(self._stream_p, ffi.NULL, ffi.NULL)
+            _check(lib.SDL_SetAudioStreamGetCallback(self._stream_p, ffi.NULL, ffi.NULL))
             _audio_stream_get_callbacks.pop(self, None)
         else:
             _audio_stream_get_callbacks[self] = callback
-            lib.SDL_SetAudioStreamGetCallback(self._stream_p, lib._sdl_audio_stream_callback, ffi.cast("void*", 0))
+            _check(
+                lib.SDL_SetAudioStreamGetCallback(self._stream_p, lib._sdl_audio_stream_callback, ffi.cast("void*", 0))
+            )
 
     @property
     def putter_callback(self) -> Callable[[AudioStream, AudioStreamCallbackData], Any] | None:
@@ -692,11 +685,13 @@ def putter_callback(self) -> Callable[[AudioStream, AudioStreamCallbackData], An
     @putter_callback.setter
     def putter_callback(self, callback: Callable[[AudioStream, AudioStreamCallbackData], Any] | None, /) -> None:
         if callback is None:
-            lib.SDL_SetAudioStreamPutCallback(self._stream_p, ffi.NULL, ffi.NULL)
+            _check(lib.SDL_SetAudioStreamPutCallback(self._stream_p, ffi.NULL, ffi.NULL))
             _audio_stream_put_callbacks.pop(self, None)
         else:
             _audio_stream_put_callbacks[self] = callback
-            lib.SDL_SetAudioStreamPutCallback(self._stream_p, lib._sdl_audio_stream_callback, ffi.cast("void*", 0))
+            _check(
+                lib.SDL_SetAudioStreamPutCallback(self._stream_p, lib._sdl_audio_stream_callback, ffi.cast("void*", 1))
+            )
 
 
 class _LoopSoundFunc:
@@ -806,7 +801,8 @@ def stop(self) -> None:
 class BasicMixer:
     """An SDL sound mixer implemented in Python and Numpy.
 
-    Example:
+    Example::
+
         import time
 
         import soundfile  # pip install soundfile
@@ -1032,17 +1028,10 @@ def open(  # noqa: A001, PLR0913
         paused:
             If True then the device will begin in a paused state.
             It can then be unpaused by assigning False to :any:`AudioDevice.paused`.
-        callback:
-            If None then this device will be opened in push mode and you'll have to use :any:`AudioDevice.queue_audio`
-            to send audio data or :any:`AudioDevice.dequeue_audio` to receive it.
-            If a callback is given then you can change it later, but you can not enable or disable the callback on an
-            opened device.
-            If True then a default callback which plays silence will be used, this is useful if you need the audio
-            device before your callback is ready.
+        callback: An optional callback to use, this is deprecated.
 
     If a callback is given then it will be called with the `AudioDevice` and a Numpy buffer of the data stream.
     This callback will be run on a separate thread.
-    Exceptions not handled by the callback become unraiseable and will be handled by :any:`sys.unraisablehook`.
 
     .. versionchanged:: Unreleased
         SDL3 returns audio devices differently, exact formatting is set with :any:`AudioDevice.new_stream` instead.

tests/test_sdl_audio.py

@@ -3,6 +3,7 @@
 import contextlib
 import sys
 import time
+from collections.abc import Callable
 from typing import Any
 
 import numpy as np
@@ -14,11 +15,19 @@
 # ruff: noqa: D103
 
 
+def device_works(device: Callable[[], tcod.sdl.audio.AudioDevice]) -> bool:
+    try:
+        device().open().close()
+    except RuntimeError:
+        return False
+    return True
+
+
 needs_audio_device = pytest.mark.xfail(
-    not list(tcod.sdl.audio.get_devices()), reason="This test requires an audio device"
+    not device_works(tcod.sdl.audio.get_default_playback), reason="This test requires an audio device"
 )
 needs_audio_capture = pytest.mark.xfail(
-    not list(tcod.sdl.audio.get_capture_devices()), reason="This test requires an audio capture device"
+    not device_works(tcod.sdl.audio.get_default_recording), reason="This test requires an audio capture device"
 )