sound.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2003 - 2025
    by David White <dave@whitevine.net>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
#include "sound.hpp"
#include "filesystem.hpp"
#include "log.hpp"
#include "preferences/preferences.hpp"
#include "random.hpp"
#include "sdl/sdl3_properties_raii.hpp"
#include "serialization/string_utils.hpp"
#include "sound_music_track.hpp"
#include "utils/general.hpp"
#include "utils/rate_counter.hpp"
 
#include <SDL3_mixer/SDL_mixer.h>
 
#include <algorithm>
#include <list>
#include <mutex>
#include <numeric>
#include <unordered_map>
#include <utility>
 
static lg::log_domain log_audio("audio");
#define DBG_AUDIO LOG_STREAM(debug, log_audio)
#define LOG_AUDIO LOG_STREAM(info, log_audio)
#define ERR_AUDIO LOG_STREAM(err, log_audio)
 
namespace utils
{
template<typename Container, typename Value>
auto find_in(Container& map, const Value& value) -> utils::optional_reference<typename Container::mapped_type>
{
    auto iter = map.find(value);
    if(iter == map.end()) {
        return utils::nullopt;
    }
 
    return iter->second;
}
 
} // namespace utils
 
namespace sound
{
namespace
{
/** Lightweight lifetime wrapper for MIX_Track. */
class channel
{
public:
    /** Creates a new type-tagged track on @a mixer. */
    void allocate_channel(MIX_Mixer* mixer, const char* type_tag)
    {
        track_.reset(MIX_CreateTrack(mixer));
        MIX_TagTrack(*this, type_tag);
    }
 
    /** Implicit conversion for use with the SDL_Mixer API. */
    operator MIX_Track*() const
    {
        return track_.get();
    }
 
private:
    std::unique_ptr<MIX_Track, decltype(&MIX_DestroyTrack)> track_{nullptr, &MIX_DestroyTrack};
};
 
std::mutex soundsource_map_mutex;
std::map<unsigned int, MIX_Track*> soundsource_map;
 
std::array<channel, 32> channel_pool{};
 
// One of these can play at a time
const auto music_channels        = utils::span{channel_pool}.subspan<0, 1>();
const auto bell_channels         = utils::span{channel_pool}.subspan<1, 1>();
const auto timer_channels        = utils::span{channel_pool}.subspan<2, 1>();
 
// Several of these can play at a time
const auto positional_channels   = utils::span{channel_pool}.subspan<3, 8>();
const auto UI_channels           = utils::span{channel_pool}.subspan<11, 2>();
const auto SFX_channels          = utils::span{channel_pool}.subspan<13, 19>();
 
class audio_cache
{
public:
    explicit audio_cache(std::size_t size)
        : max_size(size)
    {
    }
 
    MIX_Audio* get_or_insert(MIX_Mixer* mixer, const std::string& filename)
    {
        if(auto cached_audio = utils::find_in(cache, filename)) {
            DBG_AUDIO << "cache hit for " << filename;
            cached_audio->last_access = cache_item::clock::now();
            return cached_audio->value.get();
        }
 
        DBG_AUDIO << "cache miss for " << filename;
        MIX_Audio* audio = MIX_LoadAudio(mixer, filename.data(), false);
 
        if(cache.size() == max_size) {
            auto to_erase = least_recently_used();
            DBG_AUDIO << "Dropping music file from cache: " << to_erase->first;
            cache.erase(to_erase);
        }
 
        cache.try_emplace(filename, audio);
        return audio;
    }
 
    void clear()
    {
        cache.clear();
    }
 
private:
    struct cache_item
    {
        explicit cache_item(MIX_Audio* ptr)
            : value(ptr, &MIX_DestroyAudio)
        {
        }
 
        /** @note: SDL keeps its own refcount of MIX_Audio objects. */
        std::unique_ptr<MIX_Audio, decltype(&MIX_DestroyAudio)> value;
 
        using clock = std::chrono::steady_clock;
        clock::time_point last_access = clock::now();
    };
 
    const std::size_t max_size{0};
    std::unordered_map<std::string, cache_item> cache;
 
    auto least_recently_used() const -> decltype(cache)::const_iterator
    {
#ifdef __cpp_lib_ranges
        return std::ranges::min_element(cache, {},
            [](const auto& value) { return value.second.last_access; });
#else
        return std::min_element(cache.begin(), cache.end(),
            [](const auto& lhs, const auto& rhs) { return lhs.second.last_access < rhs.second.last_access; });
#endif
    }
};
 
constexpr std::size_t music_cache_limit = 30;
constexpr std::size_t sound_cache_limit = 500;
 
audio_cache music_cache{music_cache_limit};
audio_cache sound_cache{sound_cache_limit};
 
MIX_Mixer* mixer = nullptr;
std::size_t mixer_init_counter = 0;
 
using namespace std::chrono_literals;
 
utils::optional<std::chrono::steady_clock::time_point> music_start_time;
utils::rate_counter music_refresh_rate{20};
bool want_new_music = false;
auto fade_out_time = 5000ms;
bool no_fading = false;
 
std::vector<std::string> played_before;
 
//
// FIXME: the first music_track may be initialized before main()
// is reached. Using the logging facilities may lead to a SIGSEGV
// because it's not guaranteed that their objects are already alive.
//
// Use the music_track default constructor to avoid trying to
// invoke a log object while resolving paths.
//
std::vector<std::shared_ptr<sound::music_track>> playlist;
std::shared_ptr<sound::music_track> current_track;
std::shared_ptr<sound::music_track> previous_track;
 
std::vector<std::shared_ptr<sound::music_track>>::const_iterator find_track(const sound::music_track& track)
{
    return utils::ranges::find(playlist, track,
        [](const std::shared_ptr<const sound::music_track>& ptr) { return *ptr; });
}
 
} // end anon namespace
 
utils::optional<std::size_t> get_current_track_index()
{
    if(!current_track) {
        return utils::nullopt;
    }
 
    // The current track could be incidental music and not in the playlist
    auto iter = utils::ranges::find(playlist, current_track);
    if(iter == playlist.end()) {
        return utils::nullopt;
    }
 
    return std::distance(playlist.begin(), iter);
}
std::shared_ptr<music_track> get_current_track()
{
    return current_track;
}
void set_current_track(std::shared_ptr<music_track> track)
{
    previous_track = std::exchange(current_track, std::move(track));
}
std::shared_ptr<music_track> get_previous_music_track()
{
    return previous_track;
}
 
unsigned int get_num_tracks()
{
    return playlist.size();
}
 
std::shared_ptr<music_track> get_track(unsigned int i)
{
    if(i < playlist.size()) {
        return playlist[i];
    }
 
    if(i == playlist.size()) {
        return current_track;
    }
 
    return nullptr;
}
 
void set_track(unsigned int i, const std::shared_ptr<music_track>& to)
{
    if(i < playlist.size() && find_track(*to) != playlist.end()) {
        playlist[i] = std::make_shared<music_track>(*to);
    }
}
 
void remove_track(unsigned int i)
{
    if(i >= playlist.size()) {
        return;
    }
 
    // Let the track finish playing
    if(current_track && current_track == playlist[i]) {
        current_track->set_play_once(true);
    }
 
    playlist.erase(playlist.begin() + i);
}
 
namespace
{
bool track_ok(const std::string& id)
{
    LOG_AUDIO << "Considering " << id;
 
    if(!current_track) {
        return true;
    }
 
    // If they committed changes to list, we forget previous plays, but
    // still *never* repeat same track twice if we have an option.
    if(id == current_track->file_path()) {
        return false;
    }
 
    if(playlist.size() <= 3) {
        return true;
    }
 
    // Timothy Pinkham says:
    // 1) can't be repeated without 2 other pieces have already played
    // since A was played.
    // 2) cannot play more than 2 times without every other piece
    // having played at least 1 time.
 
    // Dammit, if our musicians keep coming up with algorithms, I'll
    // be out of a job!
    unsigned int num_played = 0;
    std::set<std::string> played;
    std::vector<std::string>::reverse_iterator i;
 
    for(i = played_before.rbegin(); i != played_before.rend(); ++i) {
        if(*i == id) {
            ++num_played;
            if(num_played == 2) {
                break;
            }
        } else {
            played.insert(*i);
        }
    }
 
    // If we've played this twice, must have played every other track.
    if(num_played == 2 && played.size() != playlist.size() - 1) {
        LOG_AUDIO << "Played twice with only " << played.size() << " tracks between";
        return false;
    }
 
    // Check previous previous track not same.
    i = played_before.rbegin();
    if(i != played_before.rend()) {
        ++i;
        if(i != played_before.rend()) {
            if(*i == id) {
                LOG_AUDIO << "Played just before previous";
                return false;
            }
        }
    }
 
    return true;
}
 
/**
 * Returns a random playlist index for a track that satisfies
 * @ref track_ok, or nullopt if no suitable track is found.
 */
utils::optional<std::size_t> random_next_track_index()
{
    auto indices = std::vector<std::size_t>(playlist.size());
    std::iota(indices.begin(), indices.end(), 0);
    std::shuffle(indices.begin(), indices.end(), randomness::rng::default_instance());
 
    for(const auto i : indices) {
        if(track_ok(playlist[i]->file_path())) {
            return i;
        }
    }
 
    return utils::nullopt;
}
 
std::shared_ptr<sound::music_track> choose_track()
{
    assert(!playlist.empty());
 
    auto current_index = get_current_track_index();
    std::size_t next_index{0};
 
    //
    // Shuffle if:
    // - There is no current track OR
    // - The current track is not in the playlist OR
    // - The current playlist track specifies to do so
    //
    if(!current_index || current_track->shuffle()) {
        if(playlist.size() > 1) {
            next_index = random_next_track_index().value_or(0);
        }
    } else {
        next_index = (current_index.value() + 1) % playlist.size();
    }
 
    std::shared_ptr next_track = playlist[next_index];
    DBG_AUDIO << "Next track will be " << next_track->file_path();
    played_before.push_back(current_track->file_path());
    return next_track;
}
 
std::string pick_one(const std::string& files)
{
    std::vector<std::string> ids = utils::square_parenthetical_split(files, ',', "[", "]");
 
    if(ids.empty()) {
        return "";
    }
 
    if(ids.size() == 1) {
        return ids[0];
    }
 
    // We avoid returning same choice twice if we can avoid it.
    static std::map<std::string, unsigned int> prev_choices;
    unsigned int choice;
 
    if(prev_choices.find(files) != prev_choices.end()) {
        choice = randomness::rng::default_instance().get_random_int(0, ids.size()-1 - 1);
        if(choice >= prev_choices[files]) {
            ++choice;
        }
 
        prev_choices[files] = choice;
    } else {
        choice = randomness::rng::default_instance().get_random_int(0, ids.size()-1);
        prev_choices.emplace(files, choice);
    }
 
    return ids[choice];
}
 
} // namespace
 
std::string current_driver()
{
    const char* const drvname = SDL_GetCurrentAudioDriver();
    return drvname ? drvname : "<not initialized>";
}
 
std::vector<std::string> enumerate_drivers()
{
    std::vector<std::string> res;
    int num_drivers = SDL_GetNumVideoDrivers();
 
    for(int n = 0; n < num_drivers; ++n) {
        const char* drvname = SDL_GetAudioDriver(n);
        res.emplace_back(drvname ? drvname : "<invalid driver>");
    }
 
    return res;
}
 
driver_status driver_status::query()
{
    if(mixer) {
        SDL_AudioSpec spec;
        if(MIX_GetMixerFormat(mixer, &spec)) {
            return {
                true,
                spec.freq,
                spec.format,
                spec.channels
            };
        }
    }
 
    return {};
}
 
bool init_sound()
{
    LOG_AUDIO << "Initializing audio...";
    if(SDL_WasInit(SDL_INIT_AUDIO) == 0) {
        if(!SDL_InitSubSystem(SDL_INIT_AUDIO)) {
            ERR_AUDIO << "Could not initialize audio: " << SDL_GetError();
            return false;
        }
    }
 
    if(MIX_Init()) {
        mixer_init_counter++;
    } else {
        ERR_AUDIO << "Could not initialize mixer: " << SDL_GetError();
        return false;
    }
 
    if(!mixer) {
        SDL_AudioSpec spec;
        spec.freq = 44100;
        spec.format = SDL_AUDIO_S16;
        spec.channels = 2;
        mixer = MIX_CreateMixerDevice(SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK, &spec);
        if(!mixer) {
            ERR_AUDIO << "Could not initialize audio: " << SDL_GetError();
            return false;
        }
 
        for(channel& c : music_channels) {
            c.allocate_channel(mixer, sound_tracks::music);
        }
 
        for(channel& c : bell_channels) {
            c.allocate_channel(mixer, sound_tracks::sound_bell);
        }
 
        for(channel& c : timer_channels) {
            c.allocate_channel(mixer, sound_tracks::sound_timer);
        }
 
        for(channel& c : positional_channels) {
            c.allocate_channel(mixer, sound_tracks::sound_source);
        }
 
        for(channel& c : UI_channels) {
            c.allocate_channel(mixer, sound_tracks::sound_ui);
        }
 
        for(channel& c : SFX_channels) {
            c.allocate_channel(mixer, sound_tracks::sound_fx);
        }
 
        set_sound_volume(prefs::get().sound_volume());
        set_UI_volume(prefs::get().ui_volume());
        set_music_volume(prefs::get().music_volume());
        set_bell_volume(prefs::get().bell_volume());
 
        LOG_AUDIO << "Audio initialized.";
    }
 
    return true;
}
 
void close_sound()
{
    if(mixer) {
        MIX_StopAllTracks(mixer, 0);
        channel_pool = {};
 
        MIX_DestroyMixer(mixer);
        mixer = nullptr;
    }
 
    flush_cache();
 
    // as per documentation, calling MIX_Init multiple times won't result in a failure
    // MIX_Quit then needs to be called the same number of times to make it de-initialize
    // so, make sure that always happens
    while(mixer_init_counter-- > 0) {
        MIX_Quit();
    }
 
    if(SDL_WasInit(SDL_INIT_AUDIO) != 0) {
        SDL_QuitSubSystem(SDL_INIT_AUDIO);
    }
 
    LOG_AUDIO << "Audio device released.";
}
 
void stop_music()
{
    if(mixer) {
        MIX_StopTag(mixer, sound_tracks::music, 500);
    }
}
 
void stop_sound()
{
    if(mixer) {
        MIX_StopTag(mixer, sound_tracks::sound_source, 0);
        MIX_StopTag(mixer, sound_tracks::sound_fx, 0);
    }
}
 
/*
 * For the purpose of track manipulation, we treat turn timer the same as bell
 */
void stop_bell()
{
    if(mixer) {
        MIX_StopTag(mixer, sound_tracks::sound_bell, 0);
        MIX_StopTag(mixer, sound_tracks::sound_timer, 0);
    }
}
 
void stop_UI_sound()
{
    if(mixer) {
        MIX_StopTag(mixer, sound_tracks::sound_ui, 0);
    }
}
 
void restart_music()
{
    if(mixer) {
        MIX_ResumeTag(mixer, sound_tracks::music);
    }
}
 
void restart_sound()
{
    if(mixer) {
        MIX_ResumeTag(mixer, sound_tracks::sound_source);
        MIX_ResumeTag(mixer, sound_tracks::sound_fx);
    }
}
 
void restart_bell()
{
    if(mixer) {
        MIX_ResumeTag(mixer, sound_tracks::sound_bell);
        MIX_ResumeTag(mixer, sound_tracks::sound_timer);
    }
}
 
void restart_UI_sound()
{
    if(mixer) {
        MIX_ResumeTag(mixer, sound_tracks::sound_ui);
    }
}
 
void play_music_once(const std::string& file)
{
    if(auto track = sound::music_track::create(file)) {
        set_current_track(std::move(track));
        current_track->set_play_once(true);
        play_music();
    }
}
 
void empty_playlist()
{
    playlist.clear();
}
 
void play_music()
{
    if(!current_track) {
        return;
    }
 
    music_start_time = std::chrono::steady_clock::now(); // immediate
    want_new_music = true;
    no_fading = false;
    fade_out_time = previous_track != nullptr ? previous_track->ms_after() : 0ms;
}
 
void play_track(unsigned int i)
{
    if(i >= playlist.size()) {
        set_current_track(choose_track());
    } else {
        set_current_track(playlist[i]);
    }
    play_music();
}
 
namespace
{
void play_new_music()
{
    music_start_time.reset(); // reset status: no start time
    want_new_music = true;
 
    if(!prefs::get().music_on() || !mixer || !current_track) {
        return;
    }
 
    std::string filename = current_track->file_path();
    if(auto localized = filesystem::get_localized_path(filename)) {
        filename = localized.value();
    }
 
    LOG_AUDIO << "Playing track '" << filename << "'";
    auto fading_time = current_track->ms_before();
    if(no_fading) {
        fading_time = 0ms;
    }
 
    // Halt any existing music.
    // If we don't do this SDL_Mixer blocks everything until fade out is complete.
    // Do not remove this without ensuring that it does not block.
    // If you don't want it to halt the music, ensure that fades are completed
    // before attempting to play new music.
    MIX_StopTrack(music_channels[0], 0);
 
    MIX_Audio* music = music_cache.get_or_insert(mixer, filename);
    MIX_SetTrackAudio(music_channels[0], music);
 
    // Fade in the new music
    sdl3_properties props;
    SDL_SetNumberProperty(props, MIX_PROP_PLAY_FADE_IN_MILLISECONDS_NUMBER, fading_time.count());
 
    if(!MIX_PlayTrack(music_channels[0], props)) {
        ERR_AUDIO << "Could not play music: " << SDL_GetError() << " " << filename << " ";
    }
 
    want_new_music = false;
}
 
MIX_Track* get_positional_channel(unsigned soundsource_id)
{
    std::scoped_lock lock{soundsource_map_mutex};
    const auto it = soundsource_map.find(soundsource_id);
    return it == soundsource_map.end() ? nullptr : it->second;
}
 
} // namespace
 
void play_music_config(const config& music_node, bool allow_interrupt_current_track, int i)
{
    //
    // FIXME: there is a memory leak somewhere in this function, seemingly related to the shared_ptrs
    // stored in playlist.
    //
    // vultraz 5/8/2017
    //
 
    auto track = sound::music_track::create(music_node);
    if(!track) {
        ERR_AUDIO << "cannot open track; disabled in this playlist.";
        return;
    }
 
    // If they say play once, we don't alter playlist.
    if(track->play_once()) {
        set_current_track(std::move(track));
        play_music();
        return;
    }
 
    // Clear play list unless they specify append.
    if(!track->append()) {
        playlist.clear();
    }
 
    // Avoid 2 tracks with the same name, since that can cause an infinite loop
    // in choose_track(), 2 tracks with the same name will always return the
    // current track and track_ok() doesn't allow that.
    if(find_track(*track) == playlist.end()) {
        auto insert_at = (i >= 0 && static_cast<std::size_t>(i) < playlist.size())
            ? playlist.begin() + i
            : playlist.end();
 
        // Copy the track pointer so our local variable remains non-null.
        playlist.insert(insert_at, track);
    } else {
        ERR_AUDIO << "tried to add duplicate track '" << track->file_path() << "'";
    }
 
    // They can tell us to start playing this list immediately.
    if(track->immediate()) {
        set_current_track(std::move(track));
        play_music();
    } else if(!track->append() && !allow_interrupt_current_track && current_track) {
        // Make sure the current track will finish first
        current_track->set_play_once(true);
    }
}
 
void music_thinker::process()
{
    if(MIX_GetTrackFadeFrames(music_channels[0]) != 0) {
        // Do not block everything while fading.
        return;
    }
 
    if(prefs::get().music_on()) {
        // TODO: rethink the music_thinker design, especially the use of fade_out_time
        auto now = std::chrono::steady_clock::now();
 
        bool is_playing = MIX_TrackPlaying(music_channels[0]);
        bool is_paused = MIX_TrackPaused(music_channels[0]);
        if(!music_start_time && !playlist.empty() && !is_playing && !is_paused) {
            // Pick next track, add ending time to its start time.
            set_current_track(choose_track());
            music_start_time = now;
            no_fading = true;
            fade_out_time = 0ms;
        }
 
        if(music_start_time && music_refresh_rate.poll()) {
            want_new_music = now >= *music_start_time - fade_out_time;
        }
 
        if(want_new_music) {
            if(MIX_TrackPlaying(music_channels[0])) {
                MIX_StopTrack(music_channels[0], MIX_TrackMSToFrames(music_channels[0], fade_out_time.count()));
                return;
            }
 
            play_new_music();
        }
    }
}
 
music_muter::music_muter()
    : events::sdl_handler(false)
{
    join_global();
}
 
void music_muter::handle_window_event(const SDL_Event& event)
{
    if(prefs::get().stop_music_in_background() && prefs::get().music_on()) {
        if(event.type == SDL_EVENT_WINDOW_FOCUS_GAINED) {
            MIX_ResumeTrack(music_channels[0]);
            DBG_AUDIO << "resuming music";
        } else if(event.type == SDL_EVENT_WINDOW_FOCUS_LOST) {
            if(MIX_TrackPlaying(music_channels[0])) {
                MIX_PauseTrack(music_channels[0]);
                DBG_AUDIO << "pausing music";
            }
        }
    }
}
 
void commit_music_changes()
{
    played_before.clear();
 
    // Play-once is OK if still playing.
    if(current_track) {
        if(current_track->play_once()) {
            return;
        }
 
        // If current track no longer on playlist, change it.
        for(auto m : playlist) {
            if(*current_track == *m) {
                return;
            }
        }
    }
 
    // Victory empties playlist: if next scenario doesn't specify one...
    if(playlist.empty()) {
        return;
    }
 
    // FIXME: we don't pause ms_before on this first track.  Should we?
    set_current_track(choose_track());
    play_music();
}
 
void write_music_play_list(config& snapshot)
{
    // First entry clears playlist, others append to it.
    bool append = false;
    for(auto m : playlist) {
        m->write(snapshot, append);
        append = true;
    }
}
 
void reposition_sound(unsigned id, unsigned int distance)
{
    if(MIX_Track* track = get_positional_channel(id)) {
        if(distance == distance_silent) {
            MIX_StopTrack(track, 0);
        } else {
            MIX_Point3D pos;
            pos.x = 0;
            pos.y = distance;
            pos.z = 0;
            MIX_SetTrack3DPosition(track, &pos);
        }
    }
}
 
bool is_sound_playing(int id)
{
    MIX_Track* track = get_positional_channel(id);
    return track && MIX_TrackPlaying(track);
}
 
void stop_sound(unsigned id)
{
    reposition_sound(id, distance_silent);
}
 
namespace
{
MIX_Track* find_free_channel(sound_tracks::type group)
{
    const auto search = [](const auto& span) -> MIX_Track* {
        for(channel& c : span) {
            if(!MIX_TrackPlaying(c)) {
                return c;
            }
        }
 
        return nullptr;
    };
 
    switch(group) {
    case sound_tracks::type::music:
        return search(music_channels);
    case sound_tracks::type::sound_bell:
        return search(bell_channels);
    case sound_tracks::type::sound_timer:
        return search(timer_channels);
    case sound_tracks::type::sound_source:
        return search(positional_channels);
    case sound_tracks::type::sound_ui:
        return search(UI_channels);
    case sound_tracks::type::sound_fx:
        return search(SFX_channels);
    default:
        return nullptr;
    }
}
 
void play_sound_internal(const std::string& files,
        sound_tracks::type group,
        unsigned int repeats = 0,
        unsigned int distance = 0,
        unsigned int soundsource_id = UINT_MAX,
        const std::chrono::milliseconds& loop_ticks = 0ms,
        const std::chrono::milliseconds& fadein_ticks = 0ms)
{
    if(files.empty() || !mixer) {
        return;
    }
 
    if(group == sound_tracks::type::sound_source) {
        if(soundsource_id != UINT_MAX) {
            if(is_sound_playing(soundsource_id)) {
                return;
            }
        } else {
            return;
        }
    }
 
    // find a free track in the desired group
    MIX_Track* free_channel = find_free_channel(group);
    if(!free_channel) {
        LOG_AUDIO << "All tracks dedicated to sound group(" << sound_tracks::get_string(group) << ") are busy, skipping.";
        return;
    }
 
    std::string file = pick_one(files);
    const auto filename = filesystem::get_binary_file_location("sounds", file);
    if(!filename) {
        ERR_AUDIO << "Could not locate sound file '" << file << "'.";
        return;
    }
    const auto localized = filesystem::get_localized_path(filename.value_or(""));
    std::string real_path = localized.value_or(filename.value());
 
    MIX_Point3D pos;
    pos.x = 0;
    pos.y = distance;
    pos.z = 0;
    MIX_SetTrack3DPosition(free_channel, &pos);
 
    MIX_Audio* sound = sound_cache.get_or_insert(mixer, real_path);
    MIX_SetTrackAudio(free_channel, sound);
 
    sdl3_properties props;
    if(loop_ticks > 0ms) {
        SDL_SetNumberProperty(props, MIX_PROP_PLAY_LOOPS_NUMBER, -1);
        if(fadein_ticks > 0ms) {
            SDL_SetNumberProperty(props, MIX_PROP_PLAY_FADE_IN_MILLISECONDS_NUMBER, fadein_ticks.count());
            SDL_SetNumberProperty(props, MIX_PROP_PLAY_MAX_MILLISECONDS_NUMBER, loop_ticks.count());
        }
    } else {
        if(fadein_ticks > 0ms) {
            SDL_SetNumberProperty(props, MIX_PROP_PLAY_FADE_IN_MILLISECONDS_NUMBER, fadein_ticks.count());
        } else {
            SDL_SetNumberProperty(props, MIX_PROP_PLAY_LOOPS_NUMBER, repeats);
        }
    }
 
    if(!MIX_PlayTrack(free_channel, props)) {
        ERR_AUDIO << "error playing sound effect " << real_path << " : " << SDL_GetError();
        return;
    } else if(group == sound_tracks::type::sound_source) {
        // first->first since emplace returns an iterator to a pair (what we actually want) and a boolean
        // const_cast since the callback signature only accepts void*, not const void*
        std::scoped_lock lock(soundsource_map_mutex);
        unsigned int* key = const_cast<unsigned int*>(&(soundsource_map.emplace(soundsource_id, free_channel).first->first));
        DBG_AUDIO << "adding callback for soundsource id " << *key;
        MIX_SetTrackStoppedCallback(free_channel, [](void* userdata, MIX_Track*){
            std::scoped_lock lock(soundsource_map_mutex);
            DBG_AUDIO << "in callback to erase soundsource mapping for id " << *static_cast<unsigned int*>(userdata);
            soundsource_map.erase(*static_cast<unsigned int*>(userdata));
        }, key);
    }
}
 
/** Clamp gain value to a sensible (albeit arbitrary) range. */
volume clamp_gain(volume value)
{
    return std::clamp(value, sound::silence, sound::max_volume);
}
 
} // namespace
 
void play_sound(const std::string& files, sound_tracks::type group, unsigned int repeats)
{
    if(prefs::get().sound()) {
        sound::play_sound_internal(files, group, repeats);
    }
}
 
void play_sound_positioned(const std::string& files, int repeats, unsigned int distance, unsigned int id)
{
    if(prefs::get().sound()) {
        sound::play_sound_internal(files, sound_tracks::type::sound_source, repeats, distance, id);
    }
}
 
// Play bell with separate volume setting
void play_bell(const std::string& files)
{
    if(prefs::get().turn_bell()) {
        sound::play_sound_internal(files, sound_tracks::type::sound_bell);
    }
}
 
// Play timer with separate volume setting
void play_timer(const std::string& files, const std::chrono::milliseconds& loop_ticks, const std::chrono::milliseconds& fadein_ticks)
{
    if(prefs::get().sound()) {
        sound::play_sound_internal(files, sound_tracks::type::sound_timer, 0, distance_none, UINT_MAX, loop_ticks, fadein_ticks);
    }
}
 
// Play UI sounds on separate volume than soundfx
void play_UI_sound(const std::string& files)
{
    if(prefs::get().ui_sound_on()) {
        sound::play_sound_internal(files, sound_tracks::type::sound_ui);
    }
}
 
volume get_music_volume()
{
    if(mixer) {
        return volume{MIX_GetTrackGain(sound::music_channels[0])};
    }
 
    return sound::silence;
}
 
void set_music_volume(volume vol)
{
    if(mixer) {
        MIX_SetTagGain(mixer, sound_tracks::music, clamp_gain(vol));
    }
}
 
volume get_sound_volume()
{
    if(mixer) {
        // Since set_sound_volume sets all main tracks to the same, just return the volume of any main track
        return volume{MIX_GetTrackGain(sound::positional_channels[0])};
    }
 
    return sound::silence;
}
 
void set_sound_volume(volume vol)
{
    if(mixer) {
        vol = clamp_gain(vol);
 
        MIX_SetTagGain(mixer, sound_tracks::sound_source, vol);
        MIX_SetTagGain(mixer, sound_tracks::sound_fx, vol);
    }
}
 
/*
 * For the purpose of volume setting, we treat turn timer the same as bell
 */
void set_bell_volume(volume vol)
{
    if(mixer) {
        vol = clamp_gain(vol);
 
        MIX_SetTagGain(mixer, sound_tracks::sound_bell, vol);
        MIX_SetTagGain(mixer, sound_tracks::sound_timer, vol);
    }
}
 
void set_UI_volume(volume vol)
{
    if(mixer) {
        MIX_SetTagGain(mixer, sound_tracks::sound_ui, clamp_gain(vol));
    }
}
 
void flush_cache()
{
    music_cache.clear();
    sound_cache.clear();
}
 
} // end namespace sound