<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Audaspace: fx/DynamicMusic.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Audaspace  <span id="projectnumber">1.3.0</span> </div> <div id="projectbrief">A high level audio library.</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_49abe4789985cc6a85622e26efb335d2.html">fx</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">DynamicMusic.h</div> </div> </div><!--header--> <div class="contents"> <a href="DynamicMusic_8h.html">Go to the documentation of this file.</a><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="l00002"></a><span class="lineno"> 2</span> <span class="comment">* Copyright 2015-2016 Juan Francisco Crespo Galán</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">*</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">* http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">*</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">* Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">* See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">* limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">******************************************************************************/</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="IHandle_8h.html">devices/IHandle.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="IDevice_8h.html">devices/IDevice.h</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="ISound_8h.html">ISound.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <thread></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <atomic></span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <condition_variable></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <mutex></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <a class="code" href="Audaspace_8h.html#acd7584504197a1397aaf57af797e1813">AUD_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classDynamicMusic.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="Audaspace_8h.html#ad9080e3b9907fa3d0f5df561c65aa098">AUD_API</a> <a class="code" href="classDynamicMusic.html">DynamicMusic</a></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  std::vector<std::vector<std::shared_ptr<ISound>>> m_scenes;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  std::atomic_int m_id;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">float</span> m_fadeTime;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  std::shared_ptr<IHandle> m_currentHandle;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  std::shared_ptr<IHandle> m_transitionHandle;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  std::shared_ptr<IDevice> m_device;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  std::atomic_bool m_transitioning;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  std::atomic_bool m_stopThread;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  std::atomic_int m_soundTarget;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">float</span> m_volume;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  std::thread m_fadeThread;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// delete copy constructor and operator=</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="classDynamicMusic.html">DynamicMusic</a>(<span class="keyword">const</span> <a class="code" href="classDynamicMusic.html">DynamicMusic</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="classDynamicMusic.html">DynamicMusic</a>& operator=(<span class="keyword">const</span> <a class="code" href="classDynamicMusic.html">DynamicMusic</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="classDynamicMusic.html">DynamicMusic</a>(std::shared_ptr<IDevice> device);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keyword">virtual</span> ~<a class="code" href="classDynamicMusic.html">DynamicMusic</a>();</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">int</span> addScene(std::shared_ptr<ISound> sound);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordtype">bool</span> changeScene(<span class="keywordtype">int</span> <span class="keywordtype">id</span>);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordtype">int</span> getScene();</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordtype">bool</span> addTransition(<span class="keywordtype">int</span> init, <span class="keywordtype">int</span> end, std::shared_ptr<ISound> sound);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordtype">void</span> setFadeTime(<span class="keywordtype">float</span> seconds);</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">float</span> getFadeTime();</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordtype">bool</span> resume();</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordtype">bool</span> pause();</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordtype">bool</span> seek(<span class="keywordtype">float</span> position); </div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keywordtype">float</span> getPosition();</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="keywordtype">float</span> getVolume();</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keywordtype">bool</span> setVolume(<span class="keywordtype">float</span> volume);</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <a class="code" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> getStatus();</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keywordtype">bool</span> stop();</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="comment">//Callbacks used to schedule transitions after a sound ends.</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> transitionCallback(<span class="keywordtype">void</span>* player);</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> sceneCallback(<span class="keywordtype">void</span>* player);</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="comment">//These functions can fade sounds in and out if used with a thread.</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="keywordtype">void</span> crossfadeThread();</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="keywordtype">void</span> fadeInThread();</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="keywordtype">void</span> fadeOutThread();</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> };</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <a class="code" href="Audaspace_8h.html#a4cf7088a9bb0256563f28fd13c80b066">AUD_NAMESPACE_END</a></div><div class="ttc" id="Audaspace_8h_html_acd7584504197a1397aaf57af797e1813"><div class="ttname"><a href="Audaspace_8h.html#acd7584504197a1397aaf57af797e1813">AUD_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define AUD_NAMESPACE_BEGIN</div><div class="ttdoc">Opens the audaspace namespace aud.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:116</div></div> <div class="ttc" id="IDevice_8h_html"><div class="ttname"><a href="IDevice_8h.html">IDevice.h</a></div><div class="ttdoc">The IDevice interface.</div></div> <div class="ttc" id="classDynamicMusic_html"><div class="ttname"><a href="classDynamicMusic.html">DynamicMusic</a></div><div class="ttdoc">This class allows to play music depending on a current "scene", scene changes are managed by the clas...</div><div class="ttdef"><b>Definition:</b> DynamicMusic.h:42</div></div> <div class="ttc" id="ISound_8h_html"><div class="ttname"><a href="ISound_8h.html">ISound.h</a></div><div class="ttdoc">The ISound interface.</div></div> <div class="ttc" id="Audaspace_8h_html_ad9080e3b9907fa3d0f5df561c65aa098"><div class="ttname"><a href="Audaspace_8h.html#ad9080e3b9907fa3d0f5df561c65aa098">AUD_API</a></div><div class="ttdeci">#define AUD_API</div><div class="ttdoc">Used for exporting symbols in the shared library.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:93</div></div> <div class="ttc" id="IHandle_8h_html"><div class="ttname"><a href="IHandle_8h.html">IHandle.h</a></div><div class="ttdoc">Defines the IHandle interface as well as possible states of the handle.</div></div> <div class="ttc" id="Audaspace_8h_html_a4cf7088a9bb0256563f28fd13c80b066"><div class="ttname"><a href="Audaspace_8h.html#a4cf7088a9bb0256563f28fd13c80b066">AUD_NAMESPACE_END</a></div><div class="ttdeci">#define AUD_NAMESPACE_END</div><div class="ttdoc">Closes the audaspace namespace aud.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:119</div></div> <div class="ttc" id="IHandle_8h_html_a67a0db04d321a74b7e7fcfd3f1a3f70b"><div class="ttname"><a href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a></div><div class="ttdeci">Status</div><div class="ttdoc">Status of a playback handle.</div><div class="ttdef"><b>Definition:</b> IHandle.h:30</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>