An audio mixer that supports various file formats for Simple Directmedia Layer.

This is a partial merge of the work by @Wohlstand referenced in #233.

• ~Grabs the latest GME from https://bitbucket.org/mpyne/game-music-emu/src/master/ (commit b3d158)~
• Grabs music_gme.c and edits to music.c from https://github.com/WohlSoft/SDL-Mixer-X (commit bed335)
• Modifies music_gme.c to use a new GME_StartTrack, which is simpler to work with than the "process string args" approach that exists in the fork. With this, a single Mix_Music handle can be used and its track changed at any time
• Modifies music_gme.c to better match the code style in other files (probably could use more work here)

This is working for me when compiling with Emscripten and running in the browser. I verified these formats work:

• gbs
• nsf
• spc
• vgm

I don't have an m3u. There are probably other formats, but I couldn't find a list of what GME supports.

Unfortunately I'm not sure how to verify this would work on other platforms, hopefully someone can help out there. Particularly, I have no idea how to edit the configure file.

The build can't find libFLAC.so with SDL2MIXER_FLAC=ON on an Android build, causing the build to fail:

$ ./gradlew build

...

> Task :buildCMakeDebug FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':buildCMakeDebug'.
> Expected output file at /project-name/android/build/intermediates/cxx/Debug/6w2m3w14/obj/arm64-v8a/libFLAC.so for target FLAC but there was none

...

CMakeLists.txt:

cmake_minimum_required( VERSION 3.18.0 )
cmake_policy( SET CMP0091 NEW )
project( appname )

set( SDL_LIBC ON CACHE BOOL "" FORCE )
set( SDL_TEST OFF CACHE BOOL "" FORCE )
# https://github.com/libsdl-org/SDL.git
# release-2.24.1
add_subdirectory( external/sdl )

set( BUILD_SHARED_LIBS OFF CACHE BOOL "" FORCE )
set( SDL2MIXER_FLAC ON CACHE BOOL "" FORCE )
set( SDL2MIXER_OPUS OFF CACHE BOOL "" FORCE )
set( SDL2MIXER_SAMPLES OFF CACHE BOOL "" FORCE )
set( SDL2MIXER_VENDORED ON CACHE BOOL "" FORCE )
# https://github.com/libsdl-org/SDL_mixer.git
# HEAD of 'main' branch as of today: db9da3d416077195a2f84403b2fb40955518b4ab
add_subdirectory( external/sdl-mixer )

set( SRCS "src/main.cpp" )

set( LIBS
    SDL2::SDL2main
    SDL2::SDL2-static
    SDL2_mixer::SDL2_mixer-static
    )

if( ${CMAKE_SYSTEM_NAME} MATCHES "Android")
    add_library( main SHARED ${SRCS} )
    target_link_libraries( main ${LIBS} )
else()
    add_executable( ${CMAKE_PROJECT_NAME} ${SRCS} )
    target_link_libraries( ${CMAKE_PROJECT_NAME} ${LIBS} )
endif()

src/main.cpp:

#include <SDL.h>
#include <SDL_mixer.h>

int main( int argc, char** argv )
{
    SDL_Init( SDL_INIT_EVERYTHING );
    SDL_Quit();
    return 0;
}

The same CMakeLists.txt builds successfully with SDL2MIXER_FLAC=OFF, as well as on the host Debian 11 system with:

cmake -B build -G "Ninja Multi-Config" .
cmake --build build --config Release --parallel $(nproc)

• Keeps the original stb_vorbis as intact as possible so that future updates from mainstream would be painless.
• Reduces STB_VORBIS_MAX_CHANNELS from 16 to 6 (objections?)
• Adds several missing libm function overrides,
• SDL_mixer now requires SDL >= 2.0.9 because of SDL_exp()
• Fixes slow loads and leaks in start_decoder: https://github.com/nothings/stb/pull/1174
• Fixes submap array out-of-bounds indexing bug: https://github.com/nothings/stb/pull/1312
• Replace signed overflow clamps with unsigned overflow: https://github.com/nothings/stb/issues/1168
• Replaces alloca() usage with setup_malloc() (from libxmp.)
• Fixes '-Wmaybe-uninitialized' warnings in get_seek_page_info: https://github.com/nothings/stb/pull/1172
• A minor UBSan fix and suppression: https://github.com/nothings/stb/issues/1168
• Fixes signature of dummy realloc() for STB_VORBIS_NO_CRT: https://github.com/nothings/stb/pull/1198
• Renames BUFFER_SIZE macro to STB_BUFFER_SIZE: https://github.com/nothings/stb/pull/1078
• Pulls in sample-accurate offset patch of Vitaly Novichkov: (stb_vorbis_get_playback_sample_offset, because it's used in OGG_Tell and OGG_GetSome): https://github.com/nothings/stb/issues/1294 https://github.com/nothings/stb/pull/1295
• Fixes a few warnings here and there in some environments.
• Replaces two dummy '(void) 0' with 'do {} while(0)'

There's some background on this issue in the rust-sdl2 project. It seems that on the Mac while Wave files work happily if mixer is unload before the music file is but Opus causes a SEGFAULT.

Digging deeper, it turns out that there isn't a proper guard in OPUS_Delete to make sure that the Opus library is still loaded.

The fix seems to be to make sure "opus.loaded" is greater than zero before calling opus.op_free().

Does this seem reasonable? Also, I noticed that you can leak the Opus libraries if calling OPUS_Load() more than once.

If this does make sense, I'm happy to write a merge request here. It seems like @Wohlstand would be a good mentor for this if they're willing to help me out.

Hi all,

This is essentially the same as my issue for SDL_image (https://github.com/libsdl-org/SDL_image/issues/288). Basically, native MIDI as well as decoders for Modplug and Opus have been removed from the official macOS binaries, while they are all still enabled/included (albeit in an "optional" folder) for the Windows binaries.

I understand making various dependency libraries optional, but is there a way to have pre-built optional dependencies included for the macOS release, the same way they are for Windows? A folder of pre-built frameworks that can be dragged inside the mixer framework or into the same folder as the framework?

Thanks in advance!

Austin

• Make the master_volume variable being atomic
• Fixed the master_volume behavior at the music (there a middle buffer should be allocated to safely apply the volume effect)

Bonus: whitespace clean-up at the mixer.c.

Resolves #334

An argument of property in Timidity config can be surrounded with " or ' characters to prevent splitting into several arguments if it contains spaces or other delimiter characters.

If an argument itself contains " characters it should be surrounded with ' characters and vice versa.

As far as I can tell, the last release was 2018 and there have been > 300 commits since then. Any chance for a new release? Or perhaps there are blockers for that?

In order to support static linking, SDL_mixer.pc should include a 'Libs.private' field listing all the libraries that SDL_mixer requires.

This patch adds such a field and also modifies configure.ac so that EXTRA_LDFLAGS (which is now also used as the value of 'Libs.private') no longer includes SDL_LIBS. This is done so as to prevent libraries required by SDL from being listed twice when 'pkg-config --libs --static SDL_mixer' is run (they're already shown because of the 'Requires: sdl' line in SDL_mixer.pc). Makefile.in is also adjusted accordingly.

Upstream status: submitted https://bugzilla.libsdl.org/show_bug.cgi?id=3278

Signed-off-by: Rodrigo Rebello [email protected] [Retrieved from: https://git.buildroot.net/buildroot/tree/package/sdl_mixer/0001-Add-Libs.private-field-to-pkg-config-file.patch] Signed-off-by: Fabrice Fontaine [email protected]

The current CI fails because libxmp is missing vendored library CMake support: https://github.com/libsdl-org/SDL_mixer/runs/7365768492?check_suite_focus=true

Maybe we don't need it? It's provided for Visual Studio in VisualC/external

What's the best way to fix this?

due to the compiler option /MD and the use of memcpy and memset, including SDL2_mixer.dll will create a dependency on the visual studio run time DLLs, which isn't desirable. Either use SDL_memset / SDL_memcpy or /MT instead of /MD.

Hello,

I have a use case to play digital audio samples that have loop points. Loop points are supported by various digital formats, for example RIFF WAV files can store sample points in "smpl" chunks. E.g. the audio sample has a ramp up phase that plays once and then a relatively short segment follows that needs to be looped or repeated seamlessly until the sample is stopped by an API call. Loop points in music samples are supported for certain digital audio formats by SDL_mixer now, but the feature is not possible to do with Mix_Chunk samples without breaking the ABI as I was told.

Please consider to add some placeholder in the SDL_Chunk structure to allow later addition of support for loop points in digital audio samples that are not music.

Alternative suggestion: Please unify or merge the digital non music and digital music playback API. This way there is a single interface to play any type of digital audio with optional support for loop points. One historical API that worked that way is HMI Sound Operating System for which the API specification can be found here for an example.

Thanks.

I have a use case where I must set the position of MIDI music to a particular beat index (something supported by the old allegro 4 midi player, and perhaps other midi players).

Example MIDI: https://drive.google.com/file/d/1qiE7sVyvQoVRxJftKhz-n4juuArfwri8/view?usp=share_link

And positions of tunes within:

0:    Wind Fish
81:   Overworld
233:  Hyrule Castle
553:  Lost Woods
814:  Great Sea
985:  East Hyrule
1153: Dancing Dragon
1333: Stone Tower
1556: Villages
1801: Swamp + Desert
2069: Outset Island
2189: Kakariko Village
2569: Clock Town
2753: Temple
2856: Dark World
3042: Dragon Roost
3125: Horse Race
3217: Credits
3296: Zelda's Lullaby

Note: I'm not certain if there's an off-by-one error in this code, or in the source midi player these positions are defined to work in (allegro 4), but I found I need to take the beat values above and subtract one to get the exact right positioning.

You can use the playmus example program to seek to a specific tune (you'll need a timidity.cfg and soundfont within your build directory, as always):

./playmus -n 552 TheTravelsOfLink.mid

Draft until some feedback (then I'll update the other music interfaces with NULL stubs).

This adds cmake support for building sdl_mixer with GME music support.

todo:

• [ ] libgme is currently unable to be built as a vendored library (like modplug and fluidsynth).

I was going to make a PR for this, but I couldn't for the life of me discern how this file was generated by searching through the source and repo history. So, I apologize if perhaps this issue has already been addressed, but as far as I can tell it hasn't.

This is specifically referring to the consumer Makefile within the MinGW development package, which in the most recent release is located at the root of SDL2_mixer-devel-2.6.2-mingw.zip.

The equivalent Makefile of the primary SDL2 library has the following sed command under the install-package section:

install-package:
            (...)
	    sed "s|^prefix=.*|prefix=$(prefix)|" <$(arch)/lib/pkgconfig/sdl2.pc >$(prefix)/lib/pkgconfig/sdl2.pc; \
            (...)

which of course updates the pkgconfig for the lib so that the prefix entry points to the correct location after installing.

The aforementioned SDL_mixer version of the Makefile is missing this however, and has such, no matter how the file is used the installed package config will always used the default prefix value of /opt/local/i686-w64-mingw32. If for example one installed the development libraries with make native, they get installed to /usr with the prefix in the pkgconfig then pointing to the wrong location in /opt. This causes any consumers that try to locate the MinGW lib via its '.pc' to experience errors during linking or related auto tests.

I believe the SDL_mixer equivalent should be:

install-package:
            (...)
	    sed "s|^prefix=.*|prefix=$(prefix)|" <$(arch)/lib/pkgconfig/SDL2_mixer.pc >$(prefix)/lib/pkgconfig/SDL2_mixer.pc; \
            (...)

I'm just not sure where to enact this change.

I was using version 2.0.4 of SDL_mixer and everything worked correctly, after I changed to 2.6.2 the sounds that come out when I play the mix_chunk come out all broken and buggy... but when I all a mix_music everything works correctly... edit1: In addition to these errors, which are generalized to any sound .wav file, also had 1 file .wav (Name: RetroGame.wav, is on github along with all the code) which approximately 10% of the time that started the app, the "Mix_LoadWAV" function of the error saying that "attempt to write protected memory"

I am using C#, but I am confident that this is not the problem, here is my program code:

to facilitate c# code analysis, translations of c# links have some changes such as Mix_Chunk ==> Chunk and MixChunk* ==> PChunk 
and the functions that returned MixChunk* were changed to the last argument of them to be a reference of the returned argument...
function(..., out chunck)

using SDL_Sharp.Mixer;
using System;

namespace SDL_PLUS_EXTENSIONS;
class SoundChunk
{
    PChunk chunk;
    int volume = MIX.MAX_VOLUME;

    public static SoundChunk CreateSoundChunk(string path)
    {
        return new SoundChunk(path);
    }

    SoundChunk(string path)
    {
        MIX.LoadWAV(path, out chunk);
        //Console.WriteLine(MIX.GetError());
        if (chunk.IsNull)
            throw new Exception("PChunk not create");
        MIX.VolumeChunk(chunk, volume);
    }

    public void Play(int loop)
    {
        if (MIX.PlayChannel(0, chunk, loop) == -1)
        {
            Console.WriteLine(MIX.GetError());
        }
    }

    public void SetVolume(int volume)
    {
        this.volume = volume;
        MIX.VolumeChunk(chunk, volume);
    }

    ~SoundChunk()
    {
        MIX.FreeChunk(chunk);
    }
}

class SoundMusic
{
    public Music music;
    public static SoundMusic CurrentMusic { get; private set; }

    static int volume = MIX.MAX_VOLUME;
    public static int CurrentVolume { get => volume; }

    public static SoundMusic CreateSoundMusic(string path)
    {
        return new SoundMusic(path);
    }

    SoundMusic(string path)
    {
        music = MIX.LoadMUS(path);
        if (music.IsNull)
            throw new Exception("Music not create");
    }

    public static void PlayMusic(SoundMusic music, int loop)
    {
        CurrentMusic = music;
        if (MIX.PlayMusic(music.music, loop) == -1)
        {
            Console.WriteLine(MIX.GetError());
        }
    }

    public static void SetVolume(int volume)
    {
        SoundMusic.volume = volume;
        MIX.VolumeMusic(SoundMusic.volume);
    }

    ~SoundMusic()
    {
        MIX.FreeMusic(music);
    }
}

static void Main(){
...
        SDL.Init(SdlInitFlags.Video | SdlInitFlags.Video);
        MIX.Init(MixInitFlags.Mod);
        const int audio_buffer = 4096;
        MIX.OpenAudio(MIX.DEFAULT_FREQUENCY, MIX.DEFAULT_FORMAT, MIX.DEFAULT_CHANNELS, audio_buffer);
        MIX.AllocateChannels(MIX.CHANNELS);
        //Init SDL/Image/Mixer/Ttf

        SoundMusic soundMusic = SoundMusic.CreateSoundMusic("./Files/MUSIC.wav");
        SoundMusic.SetVolume(8);
        SoundMusic.PlayMusic(soundMusic, -1);

        SoundChunk soundChunk = SoundChunk.CreateSoundChunk("./Files/RetroGame.wav");
        soundChunk.SetVolume(32);
        soundChunk.Play(3);
... loop ...
        MIX.CloseAudio();
        MIX.Quit();
}

edit2: c++ code (continues with the same error)

#include <iostream>
#include "SDL2/SDL.h"
#include "SDL2/SDL_mixer.h"

int SDL_main(int argc, char* args[]) {
    std::cout << "app start" << std::endl;

    SDL_Init(SDL_INIT_EVERYTHING);
    Mix_Init(MIX_INIT_MOD);
    std::cout << "SDL_Init && Mix_Init" << std::endl;

    const int audio_buffer = 4096;
    Mix_OpenAudio(MIX_DEFAULT_FREQUENCY, MIX_DEFAULT_FORMAT, MIX_DEFAULT_CHANNELS, audio_buffer);
    Mix_AllocateChannels(MIX_CHANNELS);
    std::cout << "Mixer Open" << std::endl;

    Mix_Chunk* chunk;
    chunk = Mix_LoadWAV("./MUSIC.wav");
    Mix_VolumeChunk(chunk, MIX_MAX_VOLUME);
    std::cout << "Mix_Chunk Load" << std::endl;

    Mix_PlayChannel(0, chunk, -1);

    bool loop = true;
    while (loop) { /* loop */ }

    Mix_FreeChunk(chunk);
    SDL_Quit();
    Mix_Quit();

    return 0;
}

What is wrong with this code? The complete code for this program is on github: https://github.com/GabrielFrigo4/SDL-Sharp/tree/master/Exemples/SDL_EXTENSIONS

(This is my first time I do an issue, any error or lack of information warns me that I fix)