Fix everything

Author: Starbuck5

buildconfig/stubs/meson.build

@@ -1,6 +1,13 @@
+pg_stub_excludes = ['.flake8']
+
+# SDL3 only!
+if sdl_api != 3
+    pg_stub_excludes += ['_audio.pyi']
+endif
+
 install_subdir(
     'pygame',
-    exclude_files: '.flake8',
+    exclude_files: pg_stub_excludes,
     install_dir: pg_dir,
     strip_directory: true,
     install_tag: 'pg-tag',

buildconfig/stubs/mypy_allow_list.txt

@@ -27,3 +27,6 @@ pygame\.pypm
 pygame\._sdl2\.mixer
 pygame\.sysfont.*
 pygame\.docs.*
+
+# Remove me when we're checking stubs for SDL3!
+pygame._audio

buildconfig/stubs/pygame/_audio.pyi

@@ -4,6 +4,9 @@ from typing import TypeVar
 from pygame.typing import FileLike
 from typing_extensions import Buffer
 
+# TODO: Support SDL3 stubchecking without failing when on SDL2 builds
+# Right now this module is unconditionally skipped in mypy_allow_list.txt
+
 def init() -> None: ...
 
 # def quit() -> None: ...
@@ -52,6 +55,7 @@ class AudioFormat:
     def __index__(self) -> int: ...
     def __repr__(self) -> str: ...
 
+UNKNOWN: AudioFormat
 U8: AudioFormat
 S8: AudioFormat
 S16LE: AudioFormat

src_c/_base_audio.c

@@ -55,7 +55,7 @@ adevice_state_dealloc(PGAudioDeviceStateObject *self)
 }
 
 static PyMemberDef adevice_state_members[] = {
-    {"id", Py_T_INT, offsetof(PGAudioDeviceStateObject, devid), Py_READONLY,
+    {"id", Py_T_UINT, offsetof(PGAudioDeviceStateObject, devid), Py_READONLY,
      NULL},
     {NULL} /* Sentinel */
 };
@@ -127,6 +127,7 @@ pg_audio_get_audio_device_channel_map(PyObject *module, PyObject *arg)
             SDL_free(channel_map);
             Py_DECREF(item);
             Py_DECREF(channel_map_list);
+            return NULL;
         }
     }
 
@@ -250,6 +251,7 @@ pg_audio_open_audio_device(PyObject *module, PyObject *const *args,
         (PGAudioDeviceStateObject *)adevice_state_type->tp_alloc(
             adevice_state_type, 0);
     if (device == NULL) {
+        SDL_CloseAudioDevice(logical_id);
         return NULL;
     }
     device->devid = logical_id;
@@ -331,6 +333,11 @@ pg_audio_create_audio_stream(PyObject *module, PyObject *const *args,
     PGAudioStreamStateObject *stream_state =
         (PGAudioStreamStateObject *)astream_state_type->tp_alloc(
             astream_state_type, 0);
+
+    if (stream_state == NULL) {
+        SDL_DestroyAudioStream(stream);
+        return NULL;
+    }
     stream_state->stream = stream;
 
     return (PyObject *)stream_state;
@@ -476,19 +483,19 @@ pg_audio_put_audio_stream_data(PyObject *module, PyObject *const *args,
     }
 
     void *buf;
-    int len;
+    Py_ssize_t len;
 
-    if (PyBytes_AsStringAndSize(bytes, (char **)&buf, (Py_ssize_t *)&len) !=
-        0) {
+    if (PyBytes_AsStringAndSize(bytes, (char **)&buf, &len) != 0) {
         Py_DECREF(bytes);
         return NULL;
     }
 
-    if (!SDL_PutAudioStreamData(stream, buf, len)) {
+    if (!SDL_PutAudioStreamData(stream, buf, (int)len)) {
         Py_DECREF(bytes);
         return RAISE(pgExc_SDLError, SDL_GetError());
     }
 
+    Py_DECREF(bytes);
     Py_RETURN_NONE;
 }
 
@@ -762,8 +769,8 @@ pg_audio_get_drivers(PyObject *module, PyObject *_null)
     for (int i = 0; i < num_drivers; i++) {
         driver = SDL_GetAudioDriver(i);
         if (driver == NULL) {
-            return RAISE(pgExc_SDLError, SDL_GetError());
             Py_DECREF(driver_list);
+            return RAISE(pgExc_SDLError, SDL_GetError());
         }
         item = PyUnicode_FromString(driver);
         if (item == NULL) {
@@ -863,13 +870,13 @@ pg_audio_load_wav(PyObject *module, PyObject *arg)
         return RAISE(pgExc_SDLError, SDL_GetError());
     }
 
-    PyObject *bytes = PyBytes_FromStringAndSize(audio_buf, audio_len);
+    PyObject *bytes = PyBytes_FromStringAndSize((char *)audio_buf, audio_len);
     SDL_free(audio_buf);
     if (bytes == NULL) {
         return NULL;
     }
 
-    return Py_BuildValue("Oiii", bytes, spec.format, spec.channels, spec.freq);
+    return Py_BuildValue("Niii", bytes, spec.format, spec.channels, spec.freq);
 }
 
 static PyObject *
@@ -882,6 +889,9 @@ pg_audio_get_default_playback_device_state(PyObject *module, PyObject *_null)
     PGAudioDeviceStateObject *device =
         (PGAudioDeviceStateObject *)adevice_state_type->tp_alloc(
             adevice_state_type, 0);
+    if (device == NULL) {
+        return NULL;
+    }
     device->devid = SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK;
 
     return (PyObject *)device;
@@ -897,6 +907,9 @@ pg_audio_get_default_recording_device_state(PyObject *module, PyObject *_null)
     PGAudioDeviceStateObject *device =
         (PGAudioDeviceStateObject *)adevice_state_type->tp_alloc(
             adevice_state_type, 0);
+    if (device == NULL) {
+        return NULL;
+    }
     device->devid = SDL_AUDIO_DEVICE_DEFAULT_RECORDING;
 
     return (PyObject *)device;
@@ -1028,23 +1041,25 @@ pg_audio_exec(PyObject *module)
     audio_state *state = GET_STATE(module);
     state->audio_initialized = false;
 
-    PyObject *audio_device_state_type =
+    state->audio_device_state_type =
         PyType_FromModuleAndSpec(module, &adevice_state_spec, NULL);
-    if (PyModule_AddObjectRef(module, "AudioDeviceState",
-                              audio_device_state_type) < 0) {
+    if (state->audio_device_state_type == NULL) {
+        return -1;
+    }
+    if (PyModule_AddType(module,
+                         (PyTypeObject *)state->audio_device_state_type) < 0) {
         return -1;
     }
 
-    state->audio_device_state_type = audio_device_state_type;
-
-    PyObject *audio_stream_state_type =
+    state->audio_stream_state_type =
         PyType_FromModuleAndSpec(module, &astream_state_spec, NULL);
-    if (PyModule_AddObjectRef(module, "AudioStreamState",
-                              audio_stream_state_type) < 0) {
+    if (state->audio_stream_state_type == NULL) {
+        return -1;
+    }
+    if (PyModule_AddType(module,
+                         (PyTypeObject *)state->audio_stream_state_type) < 0) {
         return -1;
     }
-
-    state->audio_stream_state_type = audio_stream_state_type;
 
     return 0;
 }

src_py/_audio.py

@@ -19,13 +19,14 @@ class AudioFormat:
     _MASK_BIG_ENDIAN = 1 << 12
     _MASK_SIGNED = 1 << 15
 
-    format_num_to_instance = dict()
+    # For internal use going from integers to AudioFormat instances
+    _format_num_to_instance = dict()
 
     def __init__(self, name: str, value: int) -> None:
         self._name = name
         self._value = value
 
-        AudioFormat.format_num_to_instance[value] = self
+        AudioFormat._format_num_to_instance[value] = self
 
     @property
     def bitsize(self) -> int:
@@ -64,7 +65,7 @@ def name(self) -> str:
         return self._name
 
     @property
-    def silence_value(self) -> int:
+    def silence_value(self) -> bytes:
         return _base_audio.get_silence_value_for_format(self._value)
 
     # TODO maybe unnecessary?
@@ -337,7 +338,9 @@ def frequency_ratio(self) -> float:
     @frequency_ratio.setter
     def frequency_ratio(self, value: float) -> None:
         if value <= 0 or value > 10:
-            raise ValueError("Frequency ratio must be > 0 or <= 10.")
+            raise ValueError(
+                "Frequency ratio must be between 0 and 10. (0 < ratio <= 10)"
+            )
 
         _base_audio.set_audio_stream_frequency_ratio(self._state, value)
 
@@ -392,7 +395,7 @@ def _create_audio_device(dev_state) -> AudioDevice:
     def _audio_spec_from_ints(
         format_num: int, channels: int, frequency: int
     ) -> AudioSpec:
-        format_inst = AudioFormat.format_num_to_instance[format_num]
+        format_inst = AudioFormat._format_num_to_instance[format_num]
         return AudioSpec(format_inst, channels, frequency)
 
 
@@ -415,10 +418,10 @@ def get_recording_devices() -> list[AudioDevice]:
 
 def load_wav(file: FileLike) -> tuple[AudioSpec, bytes]:
     audio_bytes, format_num, channels, frequency = _base_audio.load_wav(file)
-    return [
+    return (
         _internals._audio_spec_from_ints(format_num, channels, frequency),
         audio_bytes,
-    ]
+    )
 
 
 DEFAULT_PLAYBACK_DEVICE = _internals._create_audio_device(