SFML - Simple and Fast Multimedia Library

SFML

previous page next page
Music.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_MUSIC_HPP
26 #define SFML_MUSIC_HPP
27 
29 // Headers
31 #include <SFML/Audio/Export.hpp>
32 #include <SFML/Audio/SoundStream.hpp>
33 #include <SFML/Audio/InputSoundFile.hpp>
34 #include <SFML/System/Mutex.hpp>
35 #include <SFML/System/Time.hpp>
36 #include <string>
37 #include <vector>
38 
39 
40 namespace sf
41 {
42 class InputStream;
43 
48 class SFML_AUDIO_API Music : public SoundStream
49 {
50 public:
51 
56  Music();
57 
62  ~Music();
63 
83  bool openFromFile(const std::string& filename);
84 
106  bool openFromMemory(const void* data, std::size_t sizeInBytes);
107 
127  bool openFromStream(InputStream& stream);
128 
135  Time getDuration() const;
136 
137 protected:
138 
150  virtual bool onGetData(Chunk& data);
151 
158  virtual void onSeek(Time timeOffset);
159 
160 private:
161 
166  void initialize();
167 
169  // Member data
171  InputSoundFile m_file;
172  Time m_duration;
173  std::vector<Int16> m_samples;
174  Mutex m_mutex;
175 };
176 
177 } // namespace sf
178 
179 
180 #endif // SFML_MUSIC_HPP
181 
182 
sf::SoundStream::Chunk
Structure defining a chunk of audio data to stream.
Definition: SoundStream.hpp:53
sf::Mutex
Blocks concurrent access to shared resources from multiple threads.
Definition: Mutex.hpp:47
sf::Music
Streamed music played from an audio file.
Definition: Music.hpp:48
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::SoundStream
Abstract base class for streamed audio sources.
Definition: SoundStream.hpp:45
previous page start next page