documentation/3.0.1/SoundFileFactory_8hpp_source

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2025 Laurent Gomila (laurent@sfml-dev.org)

//

// This software is provided 'as-is', without any express or implied warranty.

// In no event will the authors be held liable for any damages arising from the use of this software.

//

// Permission is granted to anyone to use this software for any purpose,

// including commercial applications, and to alter it and redistribute it freely,

// subject to the following restrictions:

//

// 1. The origin of this software must not be misrepresented;

//    you must not claim that you wrote the original software.

//    If you use this software in a product, an acknowledgment

//    in the product documentation would be appreciated but is not required.

//

// 2. Altered source versions must be plainly marked as such,

//    and must not be misrepresented as being the original software.

//

// 3. This notice may not be removed or altered from any source distribution.

//


#pragma once


// Headers

#include <SFML/Audio/Export.hpp>


#include <filesystem>

#include <memory>

#include <unordered_map>


#include <cstddef>


namespace sf

{

class InputStream;

class SoundFileReader;

class SoundFileWriter;


class SFML_AUDIO_API SoundFileFactory

{

public:

    template <typename T>

    static void registerReader();


    template <typename T>

    static void unregisterReader();


    template <typename T>

    [[nodiscard]] static bool isReaderRegistered();


    template <typename T>

    static void registerWriter();


    template <typename T>

    static void unregisterWriter();


    template <typename T>

    [[nodiscard]] static bool isWriterRegistered();


    [[nodiscard]] static std::unique_ptr<SoundFileReader> createReaderFromFilename(const std::filesystem::path& filename);


    [[nodiscard]] static std::unique_ptr<SoundFileReader> createReaderFromMemory(const void* data, std::size_t sizeInBytes);


    [[nodiscard]] static std::unique_ptr<SoundFileReader> createReaderFromStream(InputStream& stream);


    [[nodiscard]] static std::unique_ptr<SoundFileWriter> createWriterFromFilename(const std::filesystem::path& filename);


private:

    // Types

    template <typename T>

    using CreateFnPtr = std::unique_ptr<T> (*)();


    using ReaderCheckFnPtr = bool (*)(InputStream&);

    using WriterCheckFnPtr = bool (*)(const std::filesystem::path&);


    using ReaderFactoryMap = std::unordered_map<CreateFnPtr<SoundFileReader>, ReaderCheckFnPtr>;

    using WriterFactoryMap = std::unordered_map<CreateFnPtr<SoundFileWriter>, WriterCheckFnPtr>;


    // Static member functions

    [[nodiscard]] static ReaderFactoryMap& getReaderFactoryMap();

    [[nodiscard]] static WriterFactoryMap& getWriterFactoryMap();

};


} // namespace sf


#include <SFML/Audio/SoundFileFactory.inl>


Export.hpp

SFML_AUDIO_API
#define SFML_AUDIO_API
Definition Audio/Export.hpp:42

sf::InputStream
Abstract class for custom file input streams.
Definition InputStream.hpp:46

sf::SoundFileFactory
Manages and instantiates sound file readers and writers.
Definition SoundFileFactory.hpp:50

sf::SoundFileFactory::unregisterWriter
static void unregisterWriter()
Unregister a writer.

sf::SoundFileFactory::createReaderFromFilename
static std::unique_ptr< SoundFileReader > createReaderFromFilename(const std::filesystem::path &filename)
Instantiate the right reader for the given file on disk.

sf::SoundFileFactory::createWriterFromFilename
static std::unique_ptr< SoundFileWriter > createWriterFromFilename(const std::filesystem::path &filename)
Instantiate the right writer for the given file on disk.

sf::SoundFileFactory::createReaderFromStream
static std::unique_ptr< SoundFileReader > createReaderFromStream(InputStream &stream)
Instantiate the right codec for the given file in stream.

sf::SoundFileFactory::createReaderFromMemory
static std::unique_ptr< SoundFileReader > createReaderFromMemory(const void *data, std::size_t sizeInBytes)
Instantiate the right codec for the given file in memory.

sf::SoundFileFactory::registerWriter
static void registerWriter()
Register a new writer.

sf::SoundFileFactory::unregisterReader
static void unregisterReader()
Unregister a reader.

sf::SoundFileFactory::registerReader
static void registerReader()
Register a new reader.

sf::SoundFileFactory::isReaderRegistered
static bool isReaderRegistered()
Check if a reader is registered.

sf::SoundFileFactory::isWriterRegistered
static bool isWriterRegistered()
Check if a writer is registered.

sf::SoundFileReader
Abstract base class for sound file decoding.
Definition SoundFileReader.hpp:49

sf::SoundFileWriter
Abstract base class for sound file encoding.
Definition SoundFileWriter.hpp:47

sf
Definition AudioResource.hpp:36