SFML - Simple and Fast Multimedia Library

SFML 3.0.2
Loading...
Searching...
No Matches
SoundFileReader.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2025 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#pragma once
26
28// Headers
30#include <SFML/Audio/Export.hpp>
31
32#include <SFML/Audio/SoundChannel.hpp>
33
34#include <optional>
35#include <vector>
36
37#include <cstdint>
38
39
40namespace sf
41{
42class InputStream;
43
48 class SFML_AUDIO_API SoundFileReader
49{
50public:
55 struct Info
56 {
57 std::uint64_t sampleCount{};
58 unsigned int channelCount{};
59 unsigned int sampleRate{};
60 std::vector<SoundChannel> channelMap;
61 };
62
67 virtual ~SoundFileReader() = default;
68
81 [[nodiscard]] virtual std::optional<Info> open(InputStream& stream) = 0;
82
96 virtual void seek(std::uint64_t sampleOffset) = 0;
97
107 [[nodiscard]] virtual std::uint64_t read(std::int16_t* samples, std::uint64_t maxCount) = 0;
108};
109
110} // namespace sf
111
112
Export.hpp
SFML_AUDIO_API
#define SFML_AUDIO_API
Definition Audio/Export.hpp:42
SoundChannel.hpp
sf::InputStream
Abstract class for custom file input streams.
Definition InputStream.hpp:46
sf::SoundFileReader
Abstract base class for sound file decoding.
Definition SoundFileReader.hpp:49
sf::SoundFileReader::open
virtual std::optional< Info > open(InputStream &stream)=0
Open a sound file for reading.
sf::SoundFileReader::~SoundFileReader
virtual ~SoundFileReader()=default
Virtual destructor.
sf::SoundFileReader::seek
virtual void seek(std::uint64_t sampleOffset)=0
Change the current read position to the given sample offset.
sf::SoundFileReader::read
virtual std::uint64_t read(std::int16_t *samples, std::uint64_t maxCount)=0
Read audio samples from the open file.
sf
Definition AudioResource.hpp:36
sf::SoundFileReader::Info
Structure holding the audio properties of a sound file.
Definition SoundFileReader.hpp:56
sf::SoundFileReader::Info::sampleRate
unsigned int sampleRate
Samples rate of the sound, in samples per second.
Definition SoundFileReader.hpp:59
sf::SoundFileReader::Info::sampleCount
std::uint64_t sampleCount
Total number of samples in the file.
Definition SoundFileReader.hpp:57
sf::SoundFileReader::Info::channelMap
std::vector< SoundChannel > channelMap
Map of position in sample frame to sound channel.
Definition SoundFileReader.hpp:60
sf::SoundFileReader::Info::channelCount
unsigned int channelCount
Number of channels of the sound.
Definition SoundFileReader.hpp:58