Simple and Fast Multimedia Library
Documentation for SFML 2.6.2
Initializing search
SFML
Home
Learn
Tutorials
Documentation
Download
Community
Development
Donate
Simple and Fast Multimedia Library
Home
Learn
Tutorials
Documentation
Documentation
SFML 3.1.0
SFML 3.0.2
SFML 3.0.1
SFML 3.0.0
SFML 2.6.2
SFML 2.6.1
SFML 2.6.0
SFML 2.5.1
SFML 2.5.0
SFML 2.4.2
SFML 2.4.1
SFML 2.4.0
SFML 2.3.2
SFML 2.3.1
SFML 2.3
SFML 2.2
SFML 2.1
SFML 2.0
SFML 1.6
Download
Community
Development
Warning
This page refers to an old version of SFML.
Click here to switch to the latest version.
Main Page
Related Pages
Topics
Namespaces
Classes
Files
File List
File Members
Loading...
Searching...
No Matches
SFML
include
SFML
Audio
SoundFileReader.hpp
Go to the documentation of this file.
1
2
//
3
// SFML - Simple and Fast Multimedia Library
4
// Copyright (C) 2007-2023 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
#ifndef SFML_SOUNDFILEREADER_HPP
26
#define SFML_SOUNDFILEREADER_HPP
27
29
// Headers
31
#include <
SFML/Audio/Export.hpp
>
32
#include <string>
33
34
35
namespace
sf
36
{
37
class
InputStream
;
38
43
class
SFML_AUDIO_API
SoundFileReader
44
{
45
public
:
46
51
struct
Info
52
{
53
Uint64
sampleCount
;
54
unsigned
int
channelCount
;
55
unsigned
int
sampleRate
;
56
};
57
62
virtual
~SoundFileReader
() {}
63
77
virtual
bool
open
(
InputStream
& stream,
Info
& info) = 0;
78
92
virtual
void
seek
(
Uint64
sampleOffset) = 0;
93
103
virtual
Uint64
read
(
Int16
* samples,
Uint64
maxCount) = 0;
104
};
105
106
}
// namespace sf
107
108
109
#endif
// SFML_SOUNDFILEREADER_HPP
110
111
Export.hpp
SFML_AUDIO_API
#define SFML_AUDIO_API
Definition
Audio/Export.hpp:43
sf::InputStream
Abstract class for custom file input streams.
Definition
InputStream.hpp:42
sf::SoundFileReader
Abstract base class for sound file decoding.
Definition
SoundFileReader.hpp:44
sf::SoundFileReader::seek
virtual void seek(Uint64 sampleOffset)=0
Change the current read position to the given sample offset.
sf::SoundFileReader::~SoundFileReader
virtual ~SoundFileReader()
Virtual destructor.
Definition
SoundFileReader.hpp:62
sf::SoundFileReader::read
virtual Uint64 read(Int16 *samples, Uint64 maxCount)=0
Read audio samples from the open file.
sf::SoundFileReader::open
virtual bool open(InputStream &stream, Info &info)=0
Open a sound file for reading.
sf
Definition
AlResource.hpp:35
sf::Int16
signed short Int16
Definition
Config.hpp:222
sf::Uint64
unsigned long long Uint64
Definition
Config.hpp:239
sf::SoundFileReader::Info
Structure holding the audio properties of a sound file.
Definition
SoundFileReader.hpp:52
sf::SoundFileReader::Info::sampleRate
unsigned int sampleRate
Samples rate of the sound, in samples per second.
Definition
SoundFileReader.hpp:55
sf::SoundFileReader::Info::sampleCount
Uint64 sampleCount
Total number of samples in the file.
Definition
SoundFileReader.hpp:53
sf::SoundFileReader::Info::channelCount
unsigned int channelCount
Number of channels of the sound.
Definition
SoundFileReader.hpp:54
Back to top