SFML - Simple and Fast Multimedia Library

SFML

SoundFileReader.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2017 Laurent Gomila ([email protected])
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 
91  virtual void seek(Uint64 sampleOffset) = 0;
92 
102  virtual Uint64 read(Int16* samples, Uint64 maxCount) = 0;
103 };
104 
105 } // namespace sf
106 
107 
108 #endif // SFML_SOUNDFILEREADER_HPP
109 
110 
Abstract class for custom file input streams.
Definition: InputStream.hpp:41
unsigned int sampleRate
Samples rate of the sound, in samples per second.
Abstract base class for sound file decoding.
unsigned int channelCount
Number of channels of the sound.
Structure holding the audio properties of a sound file.
Uint64 sampleCount
Total number of samples in the file.
virtual ~SoundFileReader()
Virtual destructor.