import os
from ctypes import Structure, CFUNCTYPE, c_int, c_char_p, c_void_p, c_double
from ctypes import POINTER as _P
from .dll import DLL, SDLFunc
from .version import SDL_version, SDL_VERSIONNUM
from .audio import AUDIO_S16LSB, AUDIO_S16MSB, SDL_MIX_MAXVOLUME
from .stdinc import Uint8, Uint16, Uint32, Sint16, SDL_bool
from .endian import SDL_LIL_ENDIAN, SDL_BYTEORDER
from .rwops import SDL_RWops, SDL_RWFromFile
from .error import SDL_SetError, SDL_GetError, SDL_ClearError
__all__ = [
# Structs
"Mix_Chunk", "Mix_Music",
# Defines
"SDL_MIXER_MAJOR_VERSION", "SDL_MIXER_MINOR_VERSION",
"SDL_MIXER_PATCHLEVEL", "MIX_MAJOR_VERSION", "MIX_MINOR_VERSION",
"MIX_PATCHLEVEL", "MIX_CHANNELS", "MIX_DEFAULT_FREQUENCY",
"MIX_DEFAULT_FORMAT", "MIX_DEFAULT_CHANNELS", "MIX_MAX_VOLUME",
"MIX_CHANNEL_POST", "MIX_EFFECTSMAXSPEED",
# Enums
"MIX_InitFlags",
"MIX_INIT_FLAC", "MIX_INIT_MOD", "MIX_INIT_MP3", "MIX_INIT_OGG",
"MIX_INIT_MID", "MIX_INIT_OPUS",
"Mix_Fading",
"MIX_NO_FADING", "MIX_FADING_OUT", "MIX_FADING_IN",
"Mix_MusicType",
"MUS_NONE", "MUS_CMD", "MUS_WAV", "MUS_MOD", "MUS_MID", "MUS_OGG",
"MUS_MP3", "MUS_MP3_MAD_UNUSED", "MUS_FLAC", "MUS_MODPLUG_UNUSED",
"MUS_OPUS",
# Macro Functions
"SDL_MIXER_VERSION", "MIX_VERSION", "SDL_MIXER_COMPILEDVERSION",
"SDL_MIXER_VERSION_ATLEAST", "Mix_LoadWAV", "Mix_PlayChannel",
"Mix_FadeInChannel",
"Mix_Linked_Version", "Mix_Init", "Mix_Quit", "Mix_OpenAudioDevice",
"Mix_OpenAudio", "Mix_AllocateChannels", "Mix_QuerySpec",
"Mix_LoadWAV_RW", "Mix_LoadMUS", "Mix_LoadMUS_RW",
"Mix_LoadMUSType_RW", "Mix_QuickLoad_WAV", "Mix_QuickLoad_RAW",
"Mix_FreeChunk", "Mix_FreeMusic", "Mix_GetNumChunkDecoders",
"Mix_GetChunkDecoder", "Mix_GetNumMusicDecoders",
"Mix_HasChunkDecoder", #"Mix_HasMusicDecoder",
"Mix_GetMusicDecoder", "Mix_GetMusicType",
"Mix_SetPostMix", "Mix_HookMusic",
"Mix_HookMusicFinished", "Mix_GetMusicHookData",
"Mix_ChannelFinished", "Mix_RegisterEffect", "Mix_UnregisterEffect",
"Mix_UnregisterAllEffects", "Mix_SetPanning",
"Mix_SetPosition", "Mix_SetDistance", "Mix_SetReverseStereo",
"Mix_ReserveChannels", "Mix_GroupChannel", "Mix_GroupChannels",
"Mix_GroupAvailable", "Mix_GroupCount", "Mix_GroupOldest",
"Mix_GroupNewer", "Mix_PlayChannelTimed",
"Mix_PlayMusic", "Mix_FadeInMusic", "Mix_FadeInMusicPos",
"Mix_FadeInChannelTimed", "Mix_Volume",
"Mix_VolumeChunk", "Mix_VolumeMusic", "Mix_HaltChannel",
"Mix_HaltGroup", "Mix_HaltMusic", "Mix_ExpireChannel",
"Mix_FadeOutChannel", "Mix_FadeOutGroup", "Mix_FadeOutMusic",
"Mix_FadingMusic", "Mix_FadingChannel", "Mix_Pause", "Mix_Resume",
"Mix_Paused", "Mix_PauseMusic", "Mix_ResumeMusic", "Mix_RewindMusic",
"Mix_PausedMusic", "Mix_SetMusicPosition", "Mix_Playing",
"Mix_PlayingMusic", "Mix_SetMusicCMD", "Mix_SetSynchroValue",
"Mix_GetSynchroValue", "Mix_SetSoundFonts", "Mix_GetSoundFonts",
"Mix_EachSoundFont", "Mix_GetChunk",
"Mix_CloseAudio", "Mix_SetError", "Mix_GetError", "Mix_ClearError",
# Callback Functions
"channel_finished", "music_finished", "mix_func", "soundfont_function",
"Mix_EffectFunc_t", "Mix_EffectDone_t",
# Python Functions
"get_dll_file"
]
try:
dll = DLL("SDL2_mixer", ["SDL2_mixer", "SDL2_mixer-2.0"],
os.getenv("PYSDL2_DLL_PATH"))
except RuntimeError as exc:
raise ImportError(exc)
def get_dll_file():
"""Gets the file name of the loaded SDL2_mixer library."""
return dll.libfile
_bind = dll.bind_function
# Constants, enums, type definitions, and macros
SDL_MIXER_MAJOR_VERSION = 2
SDL_MIXER_MINOR_VERSION = 0
SDL_MIXER_PATCHLEVEL = 4
def SDL_MIXER_VERSION(x):
x.major = SDL_MIXER_MAJOR_VERSION
x.minor = SDL_MIXER_MINOR_VERSION
x.patch = SDL_MIXER_PATCHLEVEL
MIX_MAJOR_VERSION = SDL_MIXER_MAJOR_VERSION
MIX_MINOR_VERSION = SDL_MIXER_MINOR_VERSION
MIX_PATCHLEVEL = SDL_MIXER_PATCHLEVEL
MIX_VERSION = SDL_MIXER_VERSION
SDL_MIXER_COMPILEDVERSION = SDL_VERSIONNUM(SDL_MIXER_MAJOR_VERSION, SDL_MIXER_MINOR_VERSION, SDL_MIXER_PATCHLEVEL)
SDL_MIXER_VERSION_ATLEAST = lambda x, y, z: (SDL_MIXER_COMPILEDVERSION >= SDL_VERSIONNUM(x, y, z))
MIX_InitFlags = c_int
MIX_INIT_FLAC = 0x00000001
MIX_INIT_MOD = 0x00000002
MIX_INIT_MP3 = 0x00000008
MIX_INIT_OGG = 0x000000010
MIX_INIT_MID = 0x00000020
MIX_INIT_OPUS = 0x00000040
Mix_Fading = c_int
MIX_NO_FADING = 0
MIX_FADING_OUT = 1
MIX_FADING_IN = 2
Mix_MusicType = c_int
MUS_NONE = 0
MUS_CMD = 1
MUS_WAV = 2
MUS_MOD = 3
MUS_MID = 4
MUS_OGG = 5
MUS_MP3 = 6
MUS_MP3_MAD_UNUSED = 7
MUS_FLAC = 9
MUS_MODPLUG_UNUSED = 10
MUS_OPUS = 11
MIX_CHANNELS = 8
MIX_DEFAULT_FREQUENCY = 22050
if SDL_BYTEORDER == SDL_LIL_ENDIAN:
MIX_DEFAULT_FORMAT = AUDIO_S16LSB
else:
MIX_DEFAULT_FORMAT = AUDIO_S16MSB
MIX_DEFAULT_CHANNELS = 2
MIX_MAX_VOLUME = SDL_MIX_MAXVOLUME
MIX_CHANNEL_POST = -2
MIX_EFFECTSMAXSPEED = "MIX_EFFECTSMAXSPEED"
[docs]class Mix_Chunk(Structure):
"""A loaded audio clip to use for playback with the mixer API.
Chunk objects are created by the :func:`Mix_LoadWAV` and ``Mix_QuickLoad``
functions, and should be freed using :func:`Mix_FreeChunk` when no longer
needed.
Attributes:
allocated (int): Whether the associated audio buffer will be freed when
the chunk is freed. ``1`` if the buffer is owned by the chunk, or
``0`` if it was allocated by a different function.
abuf (POINTER(:obj:`~ctypes.c_ubyte`)): A pointer to the chunk's audio
sample data, in the output format and sample rate of the current
mixer.
alen (int): The length of the chunk's audio buffer (in bytes).
volume (int): The volume of the chunk, with 0 being 0% and 127 being
100%.
"""
_fields_ = [("allocated", c_int),
("abuf", _P(Uint8)),
("alen", Uint32),
("volume", Uint8)]
[docs]class Mix_Music(c_void_p):
"""The opaque data type representing a loaded music file.
Music objects are created by the :func:`Mix_LoadMUS` family of functions and
should be freed using :func:`Mix_FreeMusic` when no longer needed.
"""
pass
# Callback function definitions for various methods
mix_func = CFUNCTYPE(None, c_void_p, _P(Uint8), c_int)
music_finished = CFUNCTYPE(None)
channel_finished = CFUNCTYPE(None, c_int)
Mix_EffectFunc_t = CFUNCTYPE(None, c_int, c_void_p, c_int, c_void_p)
Mix_EffectDone_t = CFUNCTYPE(None, c_int, c_void_p)
soundfont_function = CFUNCTYPE(c_int, c_char_p, c_void_p)
# Raw ctypes function definitions
_funcdefs = [
SDLFunc("Mix_Linked_Version", None, _P(SDL_version)),
SDLFunc("Mix_Init", [c_int], c_int),
SDLFunc("Mix_Quit"),
SDLFunc("Mix_OpenAudio", [c_int, Uint16, c_int, c_int], c_int),
SDLFunc("Mix_OpenAudioDevice", [c_int, Uint16, c_int, c_int, c_char_p, c_int], c_int, added='2.0.2'),
SDLFunc("Mix_AllocateChannels", [c_int], c_int),
SDLFunc("Mix_QuerySpec", [_P(c_int), _P(Uint16), _P(c_int)], c_int),
SDLFunc("Mix_LoadWAV_RW", [_P(SDL_RWops), c_int], _P(Mix_Chunk)),
SDLFunc("Mix_LoadMUS", [c_char_p], _P(Mix_Music)),
SDLFunc("Mix_LoadMUS_RW", [_P(SDL_RWops)], _P(Mix_Music)),
SDLFunc("Mix_LoadMUSType_RW", [_P(SDL_RWops), Mix_MusicType, c_int], _P(Mix_Music)),
SDLFunc("Mix_QuickLoad_WAV", [_P(Uint8)], _P(Mix_Chunk)),
SDLFunc("Mix_QuickLoad_RAW", [_P(Uint8), Uint32], _P(Mix_Chunk)),
SDLFunc("Mix_FreeChunk", [_P(Mix_Chunk)]),
SDLFunc("Mix_FreeMusic", [_P(Mix_Music)]),
SDLFunc("Mix_GetNumChunkDecoders", None, c_int),
SDLFunc("Mix_GetChunkDecoder", [c_int], c_char_p),
SDLFunc("Mix_HasChunkDecoder", [c_char_p], SDL_bool, added='2.0.2'),
SDLFunc("Mix_GetNumMusicDecoders", None, c_int),
SDLFunc("Mix_GetMusicDecoder", [c_int], c_char_p),
SDLFunc("Mix_GetMusicType", [_P(Mix_Music)], Mix_MusicType),
SDLFunc("Mix_SetPostMix", [mix_func, c_void_p]),
SDLFunc("Mix_HookMusic", [mix_func, c_void_p]),
SDLFunc("Mix_HookMusicFinished", [music_finished]),
SDLFunc("Mix_GetMusicHookData", None, c_void_p),
SDLFunc("Mix_ChannelFinished", [channel_finished]),
SDLFunc("Mix_RegisterEffect", [c_int, Mix_EffectFunc_t, Mix_EffectDone_t, c_void_p], c_int),
SDLFunc("Mix_UnregisterEffect", [c_int, Mix_EffectFunc_t], c_int),
SDLFunc("Mix_UnregisterAllEffects", [c_int]),
SDLFunc("Mix_SetPanning", [c_int, Uint8, Uint8], c_int),
SDLFunc("Mix_SetPosition", [c_int, Sint16, Uint8], c_int),
SDLFunc("Mix_SetDistance", [c_int, Uint8]),
SDLFunc("Mix_SetReverseStereo", [c_int, c_int], c_int),
SDLFunc("Mix_ReserveChannels", [c_int], c_int),
SDLFunc("Mix_GroupChannel", [c_int, c_int], c_int),
SDLFunc("Mix_GroupChannels", [c_int, c_int, c_int], c_int),
SDLFunc("Mix_GroupAvailable", [c_int], c_int),
SDLFunc("Mix_GroupCount", [c_int], c_int),
SDLFunc("Mix_GroupOldest", [c_int], c_int),
SDLFunc("Mix_GroupNewer", [c_int], c_int),
SDLFunc("Mix_PlayChannelTimed", [c_int, _P(Mix_Chunk), c_int, c_int], c_int),
SDLFunc("Mix_PlayMusic", [_P(Mix_Music), c_int], c_int),
SDLFunc("Mix_FadeInMusic", [_P(Mix_Music), c_int, c_int], c_int),
SDLFunc("Mix_FadeInMusicPos", [_P(Mix_Music), c_int, c_int, c_double], c_int),
SDLFunc("Mix_FadeInChannelTimed", [c_int, _P(Mix_Chunk), c_int, c_int, c_int], c_int),
SDLFunc("Mix_Volume", [c_int, c_int], c_int),
SDLFunc("Mix_VolumeChunk", [_P(Mix_Chunk), c_int], c_int),
SDLFunc("Mix_VolumeMusic", [c_int], c_int),
SDLFunc("Mix_HaltChannel", [c_int], c_int),
SDLFunc("Mix_HaltGroup", [c_int], c_int),
SDLFunc("Mix_HaltMusic", None, c_int),
SDLFunc("Mix_ExpireChannel", [c_int, c_int], c_int),
SDLFunc("Mix_FadeOutChannel", [c_int, c_int], c_int),
SDLFunc("Mix_FadeOutGroup", [c_int, c_int], c_int),
SDLFunc("Mix_FadeOutMusic", [c_int], c_int),
SDLFunc("Mix_FadingMusic", None, Mix_Fading),
SDLFunc("Mix_FadingChannel", [c_int], Mix_Fading),
SDLFunc("Mix_Pause", [c_int]),
SDLFunc("Mix_Resume", [c_int]),
SDLFunc("Mix_Paused", [c_int], c_int),
SDLFunc("Mix_PauseMusic"),
SDLFunc("Mix_ResumeMusic"),
SDLFunc("Mix_RewindMusic"),
SDLFunc("Mix_PausedMusic", None, c_int),
SDLFunc("Mix_SetMusicPosition", [c_double], c_int),
SDLFunc("Mix_Playing", [c_int], c_int),
SDLFunc("Mix_PlayingMusic", None, c_int),
SDLFunc("Mix_SetMusicCMD", [c_char_p], c_int),
SDLFunc("Mix_SetSynchroValue", [c_int], c_int),
SDLFunc("Mix_GetSynchroValue", None, c_int),
SDLFunc("Mix_SetSoundFonts", [c_char_p], c_int),
SDLFunc("Mix_GetSoundFonts", None, c_char_p),
SDLFunc("Mix_EachSoundFont", [soundfont_function, c_void_p], c_int),
SDLFunc("Mix_GetChunk", [c_int], _P(Mix_Chunk)),
SDLFunc("Mix_CloseAudio"),
]
_funcs = {}
for f in _funcdefs:
_funcs[f.name] = _bind(f.name, f.args, f.returns, f.added)
# Python wrapper functions
[docs]def Mix_Linked_Version():
"""Gets the version of the dynamically-linked **SDL2_mixer** library.
Returns:
POINTER(:obj:`SDL_version`): A pointer to a structure containing the
version of the SDL2_mixer library currently in use.
"""
return _funcs["Mix_Linked_Version"]()
[docs]def Mix_Init(flags):
"""Initializes the SDL2_mixer library.
Calling this function enables support for the FLAC, MOD, MP3, and/or Ogg
Vorbis audio formats as requested by the init flags. All other audio file
formats can be loaded or used regardless of whether this has been called.
The following init flags are supported:
========== =================
Format Init flag
========== =================
FLAC ``MIX_INIT_FLAC``
MOD ``MIX_INIT_MID``
MP3 ``MIX_INIT_MP3``
Ogg Vorbis ``MIX_INIT_OGG``
========== =================
This can be called multiple times to enable support for these formats
separately, or can initialize multiple formats at once by passing a set of
flags as a bitwise OR. You can also call this function with 0 as a flag
to check which audio decoding libraries have already been loaded, or to test
whether a given decoder is available on the current system::
# Initialize FLAC and MP3 support separately
for flag in [MIX_INIT_FLAC, MIX_INIT_MP3]:
Mix_Init(flag)
err = Mix_GetError() # check for any errors loading library
if len(err):
print(err)
# Initialize FLAC and MP3 support at the same time
flags = MIX_INIT_FLAC | MIX_INIT_MP3
Mix_Init(flags)
if Mix_Init(0) != flags: # verify both libraries loaded properly
print(Mix_GetError())
.. note::
This function is not guaranteed to set an error string on failure, so
the return value should be used for error checking instead of just
:func:`Mix_GetError`.
Args:
flags (int): A bitwise OR'd set of the flags of the audio formats to
load support for.
Returns:
int: A bitmask of all the currently initialized audio decoders.
"""
return _funcs["Mix_Init"](flags)
[docs]def Mix_Quit():
"""De-initializes the SDL2_mixer library.
Calling this function disables FLAC, MOD, MP3, and Ogg support and frees
all associated memory. Once this has been called, you can re-initialize
support for those audio decoders using :func:`Mix_Init` and the
corresponding init flags.
You only need to call this function once, no matter how many times
:func:`Mix_Init` was called.
"""
return _funcs["Mix_Quit"]()
[docs]def Mix_OpenAudio(frequency, format, channels, chunksize):
"""Opens the default audio output device for use with the mixer API.
This function opens the default audio device with a given output channel
count, audio sample format, sample rate, and audio buffer size, and
initializes the mixer with 8 virtual channels::
# Initialize a 44.1 kHz 16-bit stereo mixer with a 1024-byte buffer size
ret = Mix_OpenAudio(44100, sdl2.AUDIO_S16SYS, 2, 1024)
if ret < 0:
err = Mix_GetError().decode("utf8")
raise RuntimeError("Error initializing the mixer: {0}".format(err))
A sample rate of 44100 Hz (CD quality) or 48000 Hz is recommended for any
remotely modern computer. The chunk size must be a power of 8 (e.g. 512,
1024, 2048), and specifies how much audio data to send to the output device
at a time. Lower values will have lower latencies, but may introduce skips
in the audio (2048 is a safe default). Supported channel counts are 1
(mono), 2 (stereo), 4 (quad), and 6 (5.1 surround).
For a full list of supported audio format flags, see the list of format
values at the following link: https://wiki.libsdl.org/SDL_AudioSpec
.. note::
This should not be called if :func:`SDL_OpenAudio` has already opened the
default audio device (and vice-versa).
Args:
frequency (int): The output sampling rate per channel (in Hz).
format (int): A constant indicating the audio sample format to use
with the device (e.g. ``sdl2.AUDIO_S16``).
channels (int): The number of output channels to use for the device
(e.g. 2 for stereo, 1 for mono).
chunksize (int): The size of the audio buffer (in bytes).
Returns:
int: 0 on success, or -1 on error.
"""
return _funcs["Mix_OpenAudio"](frequency, format, channels, chunksize)
[docs]def Mix_OpenAudioDevice(frequency, format, channels, chunksize, device, allowed_changes):
"""Opens a specific audio output device for use with the mixer API.
A specific audio device can be opened by name using the output of the
:func:`SDL_GetAudioDeviceName` function. Alternatively, passing ``None`` as
the device name will make open the most reasonable default audio device.
The ``allowed_changes`` flag specifies which output properties (channel
count, frequency, sample format) are allowed to be be automatically changed
if not supported by the chosen audio device. See the documentation for
:func:`SDL_OpenAudioDevice` for the list of supported flags and more info.
See :func:`Mix_OpenAudio` for more usage details.
.. note::
Once an output device has been opened with this function, it should not
be opened again with :func:`SDL_OpenAudioDevice` (or vice-versa).
Args:
frequency (int): The output sampling rate per channel (in Hz).
format (int): A constant indicating the audio sample format to use
with the device (e.g. ``sdl2.AUDIO_S16``).
channels (int): The number of output channels to use for the device
(e.g. 2 for stereo, 1 for mono).
chunksize (int):
device (bytes): A UTF-8 encoded bytestring of the name of the audio
output device to open (or ``None`` for the default).
allowed_changes (int): A bitmask of flags indicating the output
properties allowed to be automatically changed to support the
output device. If 0, no changes are allowed.
Returns:
int: 0 on success, or -1 on error.
"""
return _funcs["Mix_OpenAudioDevice"](
frequency, format, channels, chunksize, device, allowed_changes
)
[docs]def Mix_AllocateChannels(numchans):
"""Sets the number of channels to use for the mixer API.
In this context, "channels" refers to the number of virtual channels used by
the mixer API for playing multiple sounds simultaneously. It does not refer
to the physical number of channels to use for the output device.
This can be called multiple times, even with sounds playing. If ``numchans``
is less than the current number of channels, the channels above the new number
will be stopped, freed, and not mixed any longer. If any channels are
deallocated, any callback set by :func:`Mix_ChannelFinished` will be called
when each channel is halted to be freed.
If this function is called with a negative number (e.g. ``-1``), it will
return the number of currently-allocated virtual mixer channels without
changing anything. If called with 0, all mixer channels will be freed.
This function has no effect on music playback.
Args:
numchans (int): The number of virtual channels to use for the mixer API,
or a negative number to query the current allocated channel count.
"""
return _funcs["Mix_AllocateChannels"](numchans)
[docs]def Mix_QuerySpec(frequency, format, channels):
"""Retrieves the actual audio format in use by the current mixer device.
This function returns the calculated info by reference, meaning that
it needs to be called using pre-allocated ctypes variables::
from ctypes import c_int, byref
freq, fmt, chans = c_int(0), c_int(0), c_int(0)
ret = Mix_QuerySpec(byref(freq), byref(fmt), byref(chans))
if ret > 0:
results = [x.value for x in (freq, fmt, chans)]
The obtained values may or may not match the parameters you passed to
:func:`Mix_OpenAudio`, depending on the audio configurations supported by
the output device.
Args:
frequency (byref(:obj:`~ctypes.c_int`)): The output sampling rate per
channel (in Hz).
format (byref(:obj:`~ctypes.c_int`)): The output format used by the
output device.
channels (byref(:obj:`~ctypes.c_int`)): The number of output channels
used by the device (e.g. 2 for stereo, 1 for mono).
Returns:
int: The number of times the mixer device has been opened, or 0 on
error.
"""
return _funcs["Mix_QuerySpec"](frequency, format, channels)
[docs]def Mix_LoadWAV_RW(src, freesrc):
"""Loads an audio clip from an SDL2 file object.
See :func:`Mix_GetChunkDecoder` for a list of supported file types.
.. note::
:func:`Mix_OpenAudioDevice` must be called before this function can be
used in order to determine the correct output format for playback.
Args:
src (:obj:`SDL_RWops`): A file object containing a valid audio clip.
freesrc (int): If non-zero, the provided file object will be closed and
freed automatically after being loaded.
Returns:
POINTER(:obj:`Mix_Chunk`): A pointer to the chunk containing the loaded
audio.
"""
return _funcs["Mix_LoadWAV_RW"](src, freesrc)
[docs]def Mix_LoadWAV(file):
"""Loads an audio clip from a file.
See :func:`Mix_GetChunkDecoder` for a list of supported file types.
.. note::
:func:`Mix_OpenAudioDevice` must be called before this function can be
used in order to determine the correct output format for playback.
Args:
file (bytes): A UTF8-encoded bytestring containing the path of the audio
clip to load.
Returns:
POINTER(:obj:`Mix_Chunk`): A pointer to the chunk containing the loaded
audio.
"""
return Mix_LoadWAV_RW(SDL_RWFromFile(file, b"rb"), 1)
[docs]def Mix_LoadMUS(file):
"""Loads music from a file.
See :func:`Mix_GetMusicDecoder` for a list of supported file types.
.. note::
:func:`Mix_OpenAudioDevice` must be called before this function can be
used in order to determine the correct output format for playback.
Args:
file (bytes): A UTF8-encoded bytestring containing the path of the music
file to load.
Returns:
POINTER(:obj:`Mix_Music`): A pointer to the object containing the loaded
music.
"""
return _funcs["Mix_LoadMUS"](file)
[docs]def Mix_LoadMUS_RW(src, freesrc):
"""Loads music from an SDL2 file object.
See :func:`Mix_GetMusicDecoder` for a list of supported file types.
.. note::
:func:`Mix_OpenAudioDevice` must be called before this function can be
used in order to determine the correct output format for playback.
Args:
src (:obj:`SDL_RWops`): A file object containing a valid music format.
freesrc (int): If non-zero, the provided file object will be closed and
freed automatically after being loaded.
Returns:
POINTER(:obj:`Mix_Music`): A pointer to the object containing the loaded
music.
"""
return _funcs["Mix_LoadMUS_RW"](src, freesrc)
[docs]def Mix_LoadMUSType_RW(src, type, freesrc):
"""Loads music from an SDL2 file object with a specific decoder.
This function supports the following audio format constants:
================= =================
Format Constant
================= =================
None (autodetect) ``MUS_NONE``
External command ``MUS_CMD``
WAVE format ``MUS_WAV``
Amiga MOD format ``MUS_MOD``
MIDI format ``MUS_MID``
Ogg Vorbis ``MUS_OGG``
MP3 format ``MUS_MP3``
FLAC format ``MUS_FLAC``
Opus format ``MUS_OPUS``
================= =================
.. note::
:func:`Mix_OpenAudioDevice` must be called before this function can be
used in order to determine the correct output format for playback.
Args:
src (:obj:`SDL_RWops`): A file object containing a valid music format.
type (int): The decoder to use for loading the file object.
freesrc (int): If non-zero, the provided file object will be closed and
freed automatically after being loaded.
Returns:
POINTER(:obj:`Mix_Music`): A pointer to the object containing the loaded
music.
"""
return _funcs["Mix_LoadMUSType_RW"](src, type, freesrc)
[docs]def Mix_QuickLoad_WAV(mem):
"""Loads a memory buffer as a WAV file.
Unlike :func:`Mix_LoadWAV_RW`, this function performs no audio format
conversion or error checking, and assumes that the WAV in the buffer is
already in the correct output format for the mixer. Unless high performance
is a must, :func:`Mix_LoadWAV_RW` is a more flexible and much safer option.
.. note::
:func:`Mix_OpenAudioDevice` must be called before this function can be
used.
Args:
mem (POINTER(:obj:`~ctypes.c_byte`)): A pointer to a memory buffer
containing a valid WAVE audio file.
Returns:
POINTER(:obj:`Mix_Chunk`): A pointer to the chunk containing the loaded
audio.
"""
return _funcs["Mix_QuickLoad_WAV"](mem)
[docs]def Mix_QuickLoad_RAW(mem, len):
"""Loads a memory buffer as a raw audio clip.
This function performs no error checking and assumes that the data in the
buffer is in the correct output format for the mixer.
This can be used for converting Numpy arrays or other Python data types
into audio clips for use with the mixer API. For example, to generate a
pure sine wave tone at a given frequency, you could use the following code::
import ctypes
import numpy as np
duration = 3 # Seconds of sound
hz = 432 # Frequency of the generated tone
dtype = np.int16 # Mixer output format is signed 16-bit int
max_int = 32767 # The max/min value for a signed 16-bit int
srate = 44100 # Sample rate for each channel is 44100 kHz
# Generate a 3 sec. sine wave for a 2-channel, 44100 Hz, AUDIO_S16 mixer
size = int((duration / 1000.0) * srate)
arr = np.sin(np.pi * np.arange(size) / srate * hz) * max_int
# Cast the array into ctypes format for use with mixer
arr_bytes = arr.tostring()
buflen = len(arr_bytes)
c_buf = (ctypes.c_ubyte * buflen).from_buffer_copy(arr_bytes)
# Convert the ctypes memory buffer into a mixer audio clip
sine_chunk = Mix_QuickLoad_RAW(
ctypes.cast(c_buf, ctypes.POINTER(ctypes.c_ubyte)), buflen
)
.. note::
You `must` keep a reference to the created ctypes buffer as long as the
resulting audio clip is in use. Otherwise, Python may automatically free
the memory associated with the audio buffer, meaning that any subsequent
attempts to play the clip will result in a segmentation fault.
.. note::
:func:`Mix_OpenAudioDevice` must be called before this function can be
used.
Args:
mem (POINTER(:obj:`~ctypes.c_byte`)): A pointer to a memory buffer
containing audio samples in the current output format.
len (int): The length (in bytes) of the memory buffer to load.
Returns:
POINTER(:obj:`Mix_Chunk`): A pointer to the chunk containing the loaded
audio.
"""
return _funcs["Mix_QuickLoad_RAW"](mem, len)
[docs]def Mix_FreeChunk(chunk):
"""Closes and frees the memory associated with a given audio clip.
This function should be called on a chunk when you are done with it. A
:obj:`Mix_Chunk` cannot be used after it has been closed.
Args:
chunk (:obj:`Mix_Chunk`): The chunk object to close.
"""
return _funcs["Mix_FreeChunk"](chunk)
[docs]def Mix_FreeMusic(music):
"""Closes and frees the memory associated with a given music object.
This function should be called on a music object when you are done with it.
A :obj:`Mix_Music` cannot be used after it has been closed.
Args:
music (:obj:`Mix_Music`): The music object to close.
"""
return _funcs["Mix_FreeMusic"](music)
[docs]def Mix_GetNumChunkDecoders():
"""Retrieves the number of available audio chunk decoders.
The returned value can differ between runs of a program due to changes in
the availability of the shared libraries required for supporting different
formats.
Returns:
int: The number of available audio chunk decoders.
"""
return _funcs["Mix_GetNumChunkDecoders"]()
[docs]def Mix_GetChunkDecoder(index):
"""Retrieves the name of a given audio chunk decoder.
The SDL_mixer library currently supports the following chunk decoders:
============ ============================= =============================
Decoder Name Format Type Notes
============ ============================= =============================
b"FLAC" Free Lossless Audio Codec
b"MOD" Amiga MOD format
b"MP3" MP3 format
b"OGG" Ogg Vorbis
b"MID" MIDI format Not always available on Linux
b"OPUS" Opus Interactive Audio Codec Added in SDL_mixer 2.0.4
b"WAVE" Waveform Audio File Format
b"AIFF" Audio Interchange File Format
b"VOC" Creative Voice file
============ ============================= =============================
Use the :func:`Mix_GetNumChunkDecoders` function to get the number of
available chunk decoders.
Returns:
bytes: The name of the given chunk decoder, or ``None`` if the index is
invalid.
"""
return _funcs["Mix_GetChunkDecoder"](index)
[docs]def Mix_HasChunkDecoder(name):
"""Checks whether a specific chunk decoder is available.
See :func:`Mix_GetChunkDecoder` for a list of valid decoder names.
Args:
name (bytes): A bytestring of the name of the decoder to query.
Returns:
int: 1 if the decoder is present, or 0 if unavailable.
"""
return _funcs["Mix_HasChunkDecoder"](name)
[docs]def Mix_GetNumMusicDecoders():
"""Retrieves the number of available music decoders.
The returned value can differ between runs of a program due to changes in
the availability of the shared libraries required for supporting different
formats.
Returns:
int: The number of available music decoders.
"""
return _funcs["Mix_GetNumMusicDecoders"]()
[docs]def Mix_GetMusicDecoder(index):
"""Retrieves the name of a given music decoder.
The SDL_mixer library currently supports the following music decoders:
============= ============================= =============================
Decoder Name Format Type Notes
============= ============================= =============================
b"FLAC" Free Lossless Audio Codec
b"MODPLUG" Amiga MOD (via libmodplug)
b"MOD" Amiga MOD (via libmikmod)
b"MP3" MP3 format
b"MPG123" MP3 format (duplicate)
b"OGG" Ogg Vorbis
b"MIDI" MIDI format Not always available on Linux
b"NATIVEMIDI" MIDI format (OS native) Not available on Linux
b"OPUS" Opus Interactive Audio Codec Added in SDL_mixer 2.0.4
b"CMD External music command Not available on Windows
b"WAVE" Waveform Audio File Format
============= ============================= =============================
Use the :func:`Mix_GetNumMusicDecoders` function to get the number of
available chunk decoders.
Returns:
bytes: The name of the given music decoder, or ``None`` if the index is
invalid.
"""
return _funcs["Mix_GetMusicDecoder"](index)
[docs]def Mix_GetMusicType(music):
"""Gets the format of a given music object.
See :func:`Mix_LoadMUSType_RW` for a list of the possible type constants.
Args:
music (:obj:`Mix_Music`): The music object for which the type will be
retrieved.
Returns:
int: A constant indicating the format of the music object, or
``MUS_NONE`` (0) if the format could not be identified.
"""
return _funcs["Mix_GetMusicType"](music)
[docs]def Mix_SetPostMix(mix_func, arg):
return _funcs["Mix_SetPostMix"](mix_func, arg)
[docs]def Mix_HookMusic(mix_func, arg):
return _funcs["Mix_HookMusic"](mix_func, arg)
[docs]def Mix_HookMusicFinished(music_finished):
return _funcs["Mix_HookMusicFinished"](music_finished)
[docs]def Mix_GetMusicHookData():
return _funcs["Mix_GetMusicHookData"]()
[docs]def Mix_ChannelFinished(channel_finished):
return _funcs["Mix_ChannelFinished"](channel_finished)
[docs]def Mix_RegisterEffect(chan, f, d, arg):
return _funcs["Mix_RegisterEffect"](chan, f, d, arg)
[docs]def Mix_UnregisterEffect(channel, f):
return _funcs["Mix_UnregisterEffect"](channel, f)
[docs]def Mix_UnregisterAllEffects(channel):
return _funcs["Mix_UnregisterAllEffects"](channel)
[docs]def Mix_SetPanning(channel, left, right):
return _funcs["Mix_SetPanning"](channel, left, right)
[docs]def Mix_SetPosition(channel, angle, distance):
return _funcs["Mix_SetPosition"](channel, angle, distance)
[docs]def Mix_SetDistance(channel, distance):
return _funcs["Mix_SetDistance"](channel, distance)
[docs]def Mix_SetReverseStereo(channel, flip):
return _funcs["Mix_SetReverseStereo"](channel, flip)
[docs]def Mix_ReserveChannels(num):
return _funcs["Mix_ReserveChannels"](num)
[docs]def Mix_GroupChannel(which, tag):
return _funcs["Mix_GroupChannel"](which, tag)
[docs]def Mix_GroupChannels(from_, to, tag):
return _funcs["Mix_GroupChannels"](from_, to, tag)
[docs]def Mix_GroupAvailable(tag):
return _funcs["Mix_GroupAvailable"](tag)
[docs]def Mix_GroupCount(tag):
return _funcs["Mix_GroupCount"](tag)
[docs]def Mix_GroupOldest(tag):
return _funcs["Mix_GroupOldest"](tag)
[docs]def Mix_GroupNewer(tag):
return _funcs["Mix_GroupNewer"](tag)
[docs]def Mix_PlayChannelTimed(channel, chunk, loops, ticks):
return _funcs["Mix_PlayChannelTimed"](channel, chunk, loops, ticks)
[docs]def Mix_PlayChannel(channel, chunk, loops):
return Mix_PlayChannelTimed(channel, chunk, loops, -1)
[docs]def Mix_PlayMusic(music, loops):
return _funcs["Mix_PlayMusic"](music, loops)
[docs]def Mix_FadeInMusic(music, loops, ms):
return _funcs["Mix_FadeInMusic"](music, loops, ms)
[docs]def Mix_FadeInMusicPos(music, loops, ms, position):
return _funcs["Mix_FadeInMusicPos"](music, loops, ms, position)
[docs]def Mix_FadeInChannelTimed(channel, chunk, loops, ms, ticks):
return _funcs["Mix_FadeInChannelTimed"](channel, chunk, loops, ms, ticks)
[docs]def Mix_FadeInChannel(channel, chunk, loops, ms):
return Mix_FadeInChannelTimed(channel, chunk, loops, ms, -1)
[docs]def Mix_Volume(channel, volume):
return _funcs["Mix_Volume"](channel, volume)
[docs]def Mix_VolumeChunk(chunk, volume):
return _funcs["Mix_VolumeChunk"](chunk, volume)
[docs]def Mix_VolumeMusic(volume):
return _funcs["Mix_VolumeMusic"](volume)
[docs]def Mix_HaltChannel(channel):
return _funcs["Mix_HaltChannel"](channel)
[docs]def Mix_HaltGroup(tag):
return _funcs["Mix_HaltGroup"](tag)
[docs]def Mix_HaltMusic():
return _funcs["Mix_HaltMusic"]()
[docs]def Mix_ExpireChannel(channel, ticks):
return _funcs["Mix_ExpireChannel"](channel, ticks)
[docs]def Mix_FadeOutChannel(which, ms):
return _funcs["Mix_FadeOutChannel"](which, ms)
[docs]def Mix_FadeOutGroup(tag, ms):
return _funcs["Mix_FadeOutGroup"](tag, ms)
[docs]def Mix_FadeOutMusic(ms):
return _funcs["Mix_FadeOutMusic"](ms)
[docs]def Mix_FadingMusic():
return _funcs["Mix_FadingMusic"]()
[docs]def Mix_FadingChannel(which):
return _funcs["Mix_FadingChannel"](which)
[docs]def Mix_Pause(channel):
return _funcs["Mix_Pause"](channel)
[docs]def Mix_Resume(channel):
return _funcs["Mix_Resume"](channel)
[docs]def Mix_Paused(channel):
return _funcs["Mix_Paused"](channel)
[docs]def Mix_PauseMusic():
return _funcs["Mix_PauseMusic"]()
[docs]def Mix_ResumeMusic():
return _funcs["Mix_ResumeMusic"]()
[docs]def Mix_RewindMusic():
return _funcs["Mix_RewindMusic"]()
[docs]def Mix_PausedMusic():
return _funcs["Mix_PausedMusic"]()
[docs]def Mix_SetMusicPosition(position):
return _funcs["Mix_SetMusicPosition"](position)
[docs]def Mix_Playing(channel):
return _funcs["Mix_Playing"](channel)
[docs]def Mix_PlayingMusic():
return _funcs["Mix_PlayingMusic"]()
[docs]def Mix_SetMusicCMD(command):
return _funcs["Mix_SetMusicCMD"](command)
[docs]def Mix_SetSynchroValue(value):
return _funcs["Mix_SetSynchroValue"](value)
[docs]def Mix_GetSynchroValue():
return _funcs["Mix_GetSynchroValue"]()
[docs]def Mix_SetSoundFonts(paths):
return _funcs["Mix_SetSoundFonts"](paths)
[docs]def Mix_GetSoundFonts():
return _funcs["Mix_GetSoundFonts"]()
[docs]def Mix_EachSoundFont(function, data):
return _funcs["Mix_EachSoundFont"](function, data)
[docs]def Mix_GetChunk(channel):
return _funcs["Mix_GetChunk"](channel)
[docs]def Mix_CloseAudio():
"""Shuts down and de-initializes the mixer API.
Calling this function stops all audio playback and closes the current mixer
device. Once called, the mixer API should not be used until re-initialized
with :func:`Mix_OpenAudioDevice`.
.. note::
If :func:`Mix_OpenAudioDevice` has been called multiple times, this must
be called an equal number of times to actually de-initialize the API.
"""
return _funcs["Mix_CloseAudio"]()
Mix_SetError = SDL_SetError
Mix_GetError = SDL_GetError
Mix_ClearError = SDL_ClearError