-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMusic_8hpp_source.htm
More file actions
149 lines (149 loc) · 18.2 KB
/
Copy pathMusic_8hpp_source.htm
File metadata and controls
149 lines (149 loc) · 18.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
<!doctype html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpp3ds · Documentation</title>
<link rel="stylesheet" href="../css/app.css" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script src="../bower_components/modernizr/modernizr.js"></script>
</head>
<body>
<div id="topnav" class="text-center">
<dl class="sub-nav">
<dd id="navlogo"><a href="/">
<img src="../img/logo.svg" />
</a></dd>
<dd><a href="/#what">What is it?</a></dd>
<dd><a href="/#download">Download</a></dd>
<dd><a href="/#faqs">FAQs</a></dd>
<dd class="active"><a href="/docs">Docs</a></dd>
</dl>
</div>
<div id="content">
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="modules.htm"><span>Modules</span></a></li>
<li><a href="annotated.htm"><span>Classes</span></a></li>
<li class="current"><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.htm"><span>File List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_0b93ed46ee854382aab85c778b89946e.htm">include</a></li><li class="navelem"><a class="el" href="dir_18d409fe281a3b15bd325ab753ead42a.htm">cpp3ds</a></li><li class="navelem"><a class="el" href="dir_f11191753e0b9218936d11d72560cde3.htm">Audio</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Music.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SFML - Simple and Fast Multimedia Library</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// subject to the following restrictions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">//</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// 1. The origin of this software must not be misrepresented;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// you must not claim that you wrote the original software.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// If you use this software in a product, an acknowledgment</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// in the product documentation would be appreciated but is not required.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// 2. Altered source versions must be plainly marked as such,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// and must not be misrepresented as being the original software.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">//</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">//</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef CPP3DS_MUSIC_HPP</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define CPP3DS_MUSIC_HPP</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Headers</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span><span class="preprocessor">#include <cpp3ds/Audio/SoundStream.hpp></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <cpp3ds/Audio/InputSoundFile.hpp></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <cpp3ds/System/Mutex.hpp></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <cpp3ds/System/Time.hpp></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">namespace </span><a class="code" href="namespacecpp3ds.htm">cpp3ds</a></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span>InputStream;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1Music.htm"> 47</a></span> <span class="keyword">class </span><a class="code" href="classcpp3ds_1_1Music.htm">Music</a> : <span class="keyword">public</span> <a class="code" href="classcpp3ds_1_1SoundStream.htm">SoundStream</a></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classcpp3ds_1_1Music.htm#a278aa01820432d5481d62b6c2d3396ec">Music</a>();</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classcpp3ds_1_1Music.htm#ae882608075ba0ac0c6083f6880ff6d0a">~Music</a>();</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">bool</span> <a class="code" href="classcpp3ds_1_1Music.htm#aed102982d9e2096381fcce2673774eb6">openFromFile</a>(<span class="keyword">const</span> std::string& filename);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">bool</span> <a class="code" href="classcpp3ds_1_1Music.htm#ae75b0a494371f104cb8cd020e77359f8">openFromMemory</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, std::size_t sizeInBytes);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">bool</span> <a class="code" href="classcpp3ds_1_1Music.htm#ace5c8ae6d93c86b835f9d820060dcfcf">openFromStream</a>(<a class="code" href="classcpp3ds_1_1InputStream.htm">InputStream</a>& stream);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <a class="code" href="classcpp3ds_1_1Time.htm">Time</a> <a class="code" href="classcpp3ds_1_1Music.htm#ab1188c6f56264086e3eb9aadf0576f4e">getDuration</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classcpp3ds_1_1Music.htm#a4916f58e056628b45e9f8278303e6383">onGetData</a>(<a class="code" href="structcpp3ds_1_1SoundStream_1_1Chunk.htm">Chunk</a>& data);</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcpp3ds_1_1Music.htm#af9865ef468e13df9011e4162065df702">onSeek</a>(<a class="code" href="classcpp3ds_1_1Time.htm">Time</a> timeOffset);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">void</span> initialize();</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="comment">// Member data</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"></span> <a class="code" href="classcpp3ds_1_1InputSoundFile.htm">InputSoundFile</a> m_file; </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <a class="code" href="classcpp3ds_1_1Time.htm">Time</a> m_duration; </div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  std::vector<Int16> m_samples; </div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <a class="code" href="classcpp3ds_1_1Mutex.htm">Mutex</a> m_mutex; </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> };</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> } <span class="comment">// namespace cpp3ds</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="preprocessor">#endif // CPP3DS_MUSIC_HPP</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div>
<div class="ttc" id="classcpp3ds_1_1Music_htm"><div class="ttname"><a href="classcpp3ds_1_1Music.htm">cpp3ds::Music</a></div><div class="ttdoc">Streamed music played from an audio file. </div><div class="ttdef"><b>Definition:</b> <a href="Music_8hpp_source.htm#l00047">Music.hpp:47</a></div></div>
<div class="ttc" id="classcpp3ds_1_1InputStream_htm"><div class="ttname"><a href="classcpp3ds_1_1InputStream.htm">cpp3ds::InputStream</a></div><div class="ttdoc">Abstract class for custom file input streams. </div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8hpp_source.htm#l00040">InputStream.hpp:40</a></div></div>
<div class="ttc" id="namespacecpp3ds_htm"><div class="ttname"><a href="namespacecpp3ds.htm">cpp3ds</a></div><div class="ttdef"><b>Definition:</b> <a href="AlResource_8hpp_source.htm#l00033">AlResource.hpp:33</a></div></div>
<div class="ttc" id="classcpp3ds_1_1SoundStream_htm"><div class="ttname"><a href="classcpp3ds_1_1SoundStream.htm">cpp3ds::SoundStream</a></div><div class="ttdoc">Abstract base class for streamed audio sources. </div><div class="ttdef"><b>Definition:</b> <a href="SoundStream_8hpp_source.htm#l00048">SoundStream.hpp:48</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Time_htm"><div class="ttname"><a href="classcpp3ds_1_1Time.htm">cpp3ds::Time</a></div><div class="ttdoc">Represents a time value. </div><div class="ttdef"><b>Definition:</b> <a href="Time_8hpp_source.htm#l00037">Time.hpp:37</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Music_htm_a278aa01820432d5481d62b6c2d3396ec"><div class="ttname"><a href="classcpp3ds_1_1Music.htm#a278aa01820432d5481d62b6c2d3396ec">cpp3ds::Music::Music</a></div><div class="ttdeci">Music()</div><div class="ttdoc">Default constructor. </div></div>
<div class="ttc" id="classcpp3ds_1_1Music_htm_ae882608075ba0ac0c6083f6880ff6d0a"><div class="ttname"><a href="classcpp3ds_1_1Music.htm#ae882608075ba0ac0c6083f6880ff6d0a">cpp3ds::Music::~Music</a></div><div class="ttdeci">~Music()</div><div class="ttdoc">Destructor. </div></div>
<div class="ttc" id="classcpp3ds_1_1Music_htm_ace5c8ae6d93c86b835f9d820060dcfcf"><div class="ttname"><a href="classcpp3ds_1_1Music.htm#ace5c8ae6d93c86b835f9d820060dcfcf">cpp3ds::Music::openFromStream</a></div><div class="ttdeci">bool openFromStream(InputStream &stream)</div><div class="ttdoc">Open a music from an audio file in a custom stream. </div></div>
<div class="ttc" id="classcpp3ds_1_1Music_htm_af9865ef468e13df9011e4162065df702"><div class="ttname"><a href="classcpp3ds_1_1Music.htm#af9865ef468e13df9011e4162065df702">cpp3ds::Music::onSeek</a></div><div class="ttdeci">virtual void onSeek(Time timeOffset)</div><div class="ttdoc">Change the current playing position in the stream source. </div></div>
<div class="ttc" id="classcpp3ds_1_1InputSoundFile_htm"><div class="ttname"><a href="classcpp3ds_1_1InputSoundFile.htm">cpp3ds::InputSoundFile</a></div><div class="ttdoc">Provide read access to sound files. </div><div class="ttdef"><b>Definition:</b> <a href="InputSoundFile_8hpp_source.htm#l00045">InputSoundFile.hpp:45</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Mutex_htm"><div class="ttname"><a href="classcpp3ds_1_1Mutex.htm">cpp3ds::Mutex</a></div><div class="ttdoc">Blocks concurrent access to shared resources from multiple threads. </div><div class="ttdef"><b>Definition:</b> <a href="Mutex_8hpp_source.htm#l00044">Mutex.hpp:44</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Music_htm_aed102982d9e2096381fcce2673774eb6"><div class="ttname"><a href="classcpp3ds_1_1Music.htm#aed102982d9e2096381fcce2673774eb6">cpp3ds::Music::openFromFile</a></div><div class="ttdeci">bool openFromFile(const std::string &filename)</div><div class="ttdoc">Open a music from an audio file. </div></div>
<div class="ttc" id="structcpp3ds_1_1SoundStream_1_1Chunk_htm"><div class="ttname"><a href="structcpp3ds_1_1SoundStream_1_1Chunk.htm">cpp3ds::SoundStream::Chunk</a></div><div class="ttdoc">Structure defining a chunk of audio data to stream. </div><div class="ttdef"><b>Definition:</b> <a href="SoundStream_8hpp_source.htm#l00056">SoundStream.hpp:56</a></div></div>
<div class="ttc" id="classcpp3ds_1_1Music_htm_a4916f58e056628b45e9f8278303e6383"><div class="ttname"><a href="classcpp3ds_1_1Music.htm#a4916f58e056628b45e9f8278303e6383">cpp3ds::Music::onGetData</a></div><div class="ttdeci">virtual bool onGetData(Chunk &data)</div><div class="ttdoc">Request a new chunk of audio samples from the stream source. </div></div>
<div class="ttc" id="classcpp3ds_1_1Music_htm_ae75b0a494371f104cb8cd020e77359f8"><div class="ttname"><a href="classcpp3ds_1_1Music.htm#ae75b0a494371f104cb8cd020e77359f8">cpp3ds::Music::openFromMemory</a></div><div class="ttdeci">bool openFromMemory(const void *data, std::size_t sizeInBytes)</div><div class="ttdoc">Open a music from an audio file in memory. </div></div>
<div class="ttc" id="classcpp3ds_1_1Music_htm_ab1188c6f56264086e3eb9aadf0576f4e"><div class="ttname"><a href="classcpp3ds_1_1Music.htm#ab1188c6f56264086e3eb9aadf0576f4e">cpp3ds::Music::getDuration</a></div><div class="ttdeci">Time getDuration() const </div><div class="ttdoc">Get the total duration of the music. </div></div>
</div><!-- fragment --></div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML Copyright © Laurent Gomila
</div>
</div>
</body>
</html>