SoundFile.hpp

Go to the documentation of this file.

// Copyright 2019-2026 Jan Niklas Hasse <jhasse@bixense.com>
// For conditions of distribution and use, see copyright notice in LICENSE.txt
#pragma once
 
#include "SoundPanning.hpp"
 
#include <future>
#include <memory>
#include <span>
#include <string>
#include <string_view>
#include <vector>
#if defined(__has_include) && __has_include(<optional>)
#include <optional>
using std::optional;
#else
#include <experimental/optional>
using std::experimental::optional;
#endif
 
namespace jngl {
 
class Channel;
class Sound;
struct SoundParams;
 
class SoundFile {
public:
    explicit SoundFile(const std::string& filename, std::launch policy = std::launch::async);
    ~SoundFile();
    SoundFile(const SoundFile&) = delete;
    SoundFile& operator=(const SoundFile&) = delete;
    SoundFile(SoundFile&&) noexcept;
    SoundFile& operator=(SoundFile&&) noexcept;
 
    static std::shared_ptr<SoundFile> get(std::string_view filename);
 
    void play();
 
    void play(Channel&);
 
    void stop();
 
    void stop(Channel&);
 
    bool isPlaying();
 
    void loop();
    void loop(Channel&);
 
    [[nodiscard]] SoundPanning playWithPanning();
    [[nodiscard]] SoundPanning playWithPanning(Channel&);
 
    [[nodiscard]] SoundPanning loopWithPanning();
    [[nodiscard]] SoundPanning loopWithPanning(Channel&);
 
    void setVolume(float v);
 
    void load();
 
    std::chrono::milliseconds length() const;
 
    float progress() const;
 
    std::span<float> getSamples();
 
private:
    std::weak_ptr<Sound> sound;
    std::shared_ptr<std::vector<float>> buffer;
};
 
} // namespace jngl