AudioEngine.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <cstddef>
#include <filesystem>
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
 
class QSoundEffect;

 
namespace hmi {

class AudioEngine {
public:
    enum class ForceMuted { Yes };

    AudioEngine();

    explicit AudioEngine(ForceMuted);
 
    ~AudioEngine();
 
    AudioEngine(const AudioEngine&) = delete;
    AudioEngine& operator=(const AudioEngine&) = delete;
    AudioEngine(AudioEngine&&) = delete;
    AudioEngine& operator=(AudioEngine&&) = delete;

    [[nodiscard]] bool muted() const noexcept {
        return _muted;
    }

    void setVolume(float volume);

    [[nodiscard]] float volume() const noexcept {
        return _volume;
    }

    void preload(const std::string& id, const std::filesystem::path& file);

    void play(const std::string& id);
 
private:
    static constexpr std::size_t MAX_INSTANCES_PER_EVENT = 3;
 
    struct Sample {
        std::vector<std::unique_ptr<QSoundEffect>> instances;
        std::size_t nextInstance = 0;  
    };
 
    std::unordered_map<std::string, Sample> _samples;
    float _volume = 1.0f;
    bool _muted = false;
};
 
}  // namespace hmi