Hard crash after sound finishes playing with python 3.12

[scottnm]

overview

simpleaudio 1.0.4 seems to crash for me when using python 3.12

the same crash does not reproduce in python 3.11

the crash does not appear to be any form of python failure that I can either catch as an exception or intercept with a python debugger

example

Here's the sample code I'm testing with

try:
    wav_file = simpleaudio.WaveObject.from_wave_file('test.wav')
    print('playing sound(s) using simpleaudio')
    play_obj = wav_file.play()
    play_obj.wait_done()
    print('done')
    play_obj.stop()
    print('stopped')
except BaseException as ex:
    print(f"caught exception {ex}")

when run from a python 3.12 environment with simpleaudio 1.0.4, this is the output

> python .\main.py
playing sound(s) using simpleaudio

here's the same run but from a python 3.11 environment

> python .\main.py
playing sound(s) using simpleaudio
done
stopped

Repro Environment information

• full python versions: 3.11.0 and 3.12.1
• OS: Windows 10

[scottnm]

for additional context, I found another user on reddit who seemed to be experiencing a similar problem (although their repro was via pydub) https://www.reddit.com/r/pythonhelp/comments/17vw5zy/python_is_hard_crashing_with_a_simple_mp3_play/

though if I understand correctly, pydub uses simpleaudio for playback

[cexen]

The cause of the segmentation fault seems to be calling PyMem_Free(*) without acquiring the GIL.

• 3.12: "Python memory allocator called without holding the GIL" with PyMem_Free as Py_AtExit python/cpython#105690
• https://docs.python.org/3.11/c-api/memory.html#memory-interface

There are two solutions (both of which solved the problem for me). :

1. Replace all PyMem_Malloc(*) with PyMem_RawMalloc(*) and PyMem_Free(*) with PyMem_RawFree(*).
2. Sandwich all PyMem_Free(*) between PyGILState_STATE gstate = PyGILState_Ensure(); and PyGILState_Release(gstate);.

The former solution is probably better.

With the above changes and rebuild I am able to use simpleaudio in Py3.12.
https://github.com/cexen/py-simple-audio

pip install -U --force git+https://github.com/cexen/py-simple-audio.git

I am not familiar enough with package development (especially CI and backward compatibility) to know how to make the necessary changes for users in all environments...

[Spacexplorer11]

@cexen Thanks a lot! I got the same issue and this fixed it!

[andrewdavidjamesburke]

Yeah this bug renders simpleaudio unusable.

[jamesdh]

Also experiencing this with Python 3.12.8, although for me I get the warning "There appear to be 1 leaked semaphore objects to clean up at shutdown". Installing @cexen's version fixed it for me, otherwise simple audio appears to be dead in the water with Python 3.12+

[aum7]

same here

linux mint 22 wilma
using py3.12.3

using either
accent = simpleaudio.WaveObject.from_wave_file("myaudio.wav") accent.play()

or

accent_obj = accent.play()

accent_obj.wait_done()

accent_obj.stop()
`

gives terminal output :

segmentation fault (core dumped)

while i was installing simpleaudio via pip, i got `... deprecated ...˙ error, relating to a code that was deprecated in current python (3.12)

the error was on my side, i had not installed required libs (libasound2-dev)

unfortunately i cleared the terminal, and there is no way to get back terminal output / error (so says mighty uncle google)

thx for sharing

have fun

@cexen : thx for fix, works like a charm, bow

[OsamaAlAhmadieh]

are there any plans to get this issue fixed?

[cexen]

The original maintainer is no longer maintaining this package due to limited resources.
The project needs to be taken over or sponsored by someone (may be by you)...

[scottbottgo]

The cause of the segmentation fault seems to be calling PyMem_Free(*) without acquiring the GIL.

* [3.12: "Python memory allocator called without holding the GIL" with `PyMem_Free` as `Py_AtExit` python/cpython#105690](https://github.com/python/cpython/issues/105690)

* https://docs.python.org/3.11/c-api/memory.html#memory-interface

There are two solutions (both of which solved the problem for me). :

1. Replace all `PyMem_Malloc(*)` with `PyMem_RawMalloc(*)` and `PyMem_Free(*)` with `PyMem_RawFree(*)`.

2. Sandwich all `PyMem_Free(*)` between `PyGILState_STATE gstate = PyGILState_Ensure();` and `PyGILState_Release(gstate);`.

The former solution is probably better.

With the above changes and rebuild I am able to use simpleaudio in Py3.12. https://github.com/cexen/py-simple-audio

pip install -U --force git+https://github.com/cexen/py-simple-audio.git

I am not familiar enough with package development (especially CI and backward compatibility) to know how to make the necessary changes for users in all environments...

Thank you so much