documentation/3.0.0/InputSoundFile_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2024 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 <SFML/Audio/SoundFileReader.hpp>


#include <filesystem>

#include <memory>

#include <vector>


#include <cstddef>

#include <cstdint>


namespace sf

{

class Time;

class InputStream;


class SFML_AUDIO_API InputSoundFile

{

public:

    InputSoundFile() = default;


    explicit InputSoundFile(const std::filesystem::path& filename);


    InputSoundFile(const void* data, std::size_t sizeInBytes);


    explicit InputSoundFile(InputStream& stream);


    [[nodiscard]] bool openFromFile(const std::filesystem::path& filename);


    [[nodiscard]] bool openFromMemory(const void* data, std::size_t sizeInBytes);


    [[nodiscard]] bool openFromStream(InputStream& stream);


    [[nodiscard]] std::uint64_t getSampleCount() const;


    [[nodiscard]] unsigned int getChannelCount() const;


    [[nodiscard]] unsigned int getSampleRate() const;


    [[nodiscard]] const std::vector<SoundChannel>& getChannelMap() const;


    [[nodiscard]] Time getDuration() const;


    [[nodiscard]] Time getTimeOffset() const;


    [[nodiscard]] std::uint64_t getSampleOffset() const;


    void seek(std::uint64_t sampleOffset);


    void seek(Time timeOffset);


    [[nodiscard]] std::uint64_t read(std::int16_t* samples, std::uint64_t maxCount);


    void close();


private:

    struct SFML_AUDIO_API StreamDeleter

    {

        StreamDeleter(bool theOwned);


        // To accept ownership transfer from usual std::unique_ptr<T>

        template <typename T>

        StreamDeleter(const std::default_delete<T>&);


        void operator()(InputStream* ptr) const;


        bool owned{true};

    };


    // Member data

    std::unique_ptr<SoundFileReader> m_reader;

    std::unique_ptr<InputStream, StreamDeleter> m_stream{nullptr, false};

    std::uint64_t             m_sampleOffset{};

    std::uint64_t             m_sampleCount{};

    unsigned int              m_sampleRate{};

    std::vector<SoundChannel> m_channelMap;

};


} // namespace sf


Export.hpp

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

SoundFileReader.hpp

sf::InputSoundFile::InputSoundFile
InputSoundFile(const std::filesystem::path &filename)
Construct a sound file from the disk for reading.

sf::InputSoundFile::openFromStream
bool openFromStream(InputStream &stream)
Open a sound file from a custom stream for reading.

sf::InputSoundFile::InputSoundFile
InputSoundFile(const void *data, std::size_t sizeInBytes)
Construct a sound file in memory for reading.

sf::InputSoundFile::openFromFile
bool openFromFile(const std::filesystem::path &filename)
Open a sound file from the disk for reading.

sf::InputSoundFile::openFromMemory
bool openFromMemory(const void *data, std::size_t sizeInBytes)
Open a sound file in memory for reading.

sf::InputSoundFile::getChannelCount
unsigned int getChannelCount() const
Get the number of channels used by the sound.

sf::InputSoundFile::getSampleCount
std::uint64_t getSampleCount() const
Get the total number of audio samples in the file.

sf::InputSoundFile::InputSoundFile
InputSoundFile()=default
Default constructor.

sf::InputSoundFile::getSampleRate
unsigned int getSampleRate() const
Get the sample rate of the sound.

sf::InputSoundFile::getSampleOffset
std::uint64_t getSampleOffset() const
Get the read offset of the file in samples.

sf::InputSoundFile::seek
void seek(Time timeOffset)
Change the current read position to the given time offset.

sf::InputSoundFile::InputSoundFile
InputSoundFile(InputStream &stream)
Construct a sound file from a custom stream for reading.

sf::InputSoundFile::getDuration
Time getDuration() const
Get the total duration of the sound file.

sf::InputSoundFile::getChannelMap
const std::vector< SoundChannel > & getChannelMap() const
Get the map of position in sample frame to sound channel.

sf::InputSoundFile::read
std::uint64_t read(std::int16_t *samples, std::uint64_t maxCount)
Read audio samples from the open file.

sf::InputSoundFile::getTimeOffset
Time getTimeOffset() const
Get the read offset of the file in time.

sf::InputSoundFile::close
void close()
Close the current file.

sf::InputSoundFile::seek
void seek(std::uint64_t sampleOffset)
Change the current read position to the given sample offset.

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

sf::Time
Represents a time value.
Definition Time.hpp:42

sf
Definition AudioResource.hpp:36