SFML 2.3.1

- Main Page
- Related Pages
- Modules
- Classes
- Files

- File List

InputSoundFile.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2015 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_INPUTSOUNDFILE_HPP
26 #define SFML_INPUTSOUNDFILE_HPP
27
29 // Headers
31 #include <SFML/Audio/Export.hpp>
32 #include <SFML/System/NonCopyable.hpp>
33 #include <SFML/System/Time.hpp>
34 #include <string>
35
36
37 namespace sf
38 {
39 class InputStream;
40 class SoundFileReader;
41
46 class SFML_AUDIO_API InputSoundFile : NonCopyable
47 {
48 public:
49
54 InputSoundFile();
55
60 ~InputSoundFile();
61
72 bool openFromFile(const std::string& filename);
73
85 bool openFromMemory(const void* data, std::size_t sizeInBytes);
86
97 bool openFromStream(InputStream& stream);
98
109 bool openForWriting(const std::string& filename, unsigned int channelCount, unsigned int sampleRate);
110
117 Uint64 getSampleCount() const;
118
125 unsigned int getChannelCount() const;
126
133 unsigned int getSampleRate() const;
134
144 Time getDuration() const;
145
159 void seek(Uint64 sampleOffset);
160
173 void seek(Time timeOffset);
174
184 Uint64 read(Int16* samples, Uint64 maxCount);
185
186 private:
187
192 void close();
193
195 // Member data
197 SoundFileReader* m_reader;
198 InputStream* m_stream;
199 bool m_streamOwned;
200 Uint64 m_sampleCount;
201 unsigned int m_channelCount;
202 unsigned int m_sampleRate;
203 };
204
205 } // namespace sf
206
207
208 #endif // SFML_INPUTSOUNDFILE_HPP
209
210
sf::InputStream
Abstract class for custom file input streams.
Definition: InputStream.hpp:41
sf::Time
Represents a time value.
Definition: Time.hpp:40
sf::InputSoundFile
Provide read access to sound files.
Definition: InputSoundFile.hpp:46
sf::SoundFileReader
Abstract base class for sound file decoding.
Definition: SoundFileReader.hpp:43
sf::NonCopyable
Utility class that makes any derived class non-copyable.
Definition: NonCopyable.hpp:41
sf
Definition: AlResource.hpp:34