<!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: sequence/SequenceData.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_f3f9eec4201a02bb5cab5b60add364d7.html">sequence</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">SequenceData.h</div> </div> </div><!--header--> <div class="contents"> <a href="SequenceData_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 2009-2016 Jörg Müller</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="Specification_8h.html">respec/Specification.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="AnimateableProperty_8h.html">sequence/AnimateableProperty.h</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="I3DDevice_8h.html">devices/I3DDevice.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="ILockable_8h.html">util/ILockable.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <list></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <mutex></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <a class="code" href="Audaspace_8h.html#acd7584504197a1397aaf57af797e1813">AUD_NAMESPACE_BEGIN</a></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> <span class="keyword">class </span><a class="code" href="classSequenceEntry.html">SequenceEntry</a>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span><a class="code" href="classISound.html">ISound</a>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classSequenceData.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="Audaspace_8h.html#ad9080e3b9907fa3d0f5df561c65aa098">AUD_API</a> <a class="code" href="classSequenceData.html">SequenceData</a> : <span class="keyword">public</span> <a class="code" href="classILockable.html">ILockable</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">friend</span> <span class="keyword">class </span><a class="code" href="classSequenceReader.html">SequenceReader</a>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="structSpecs.html">Specs</a> m_specs;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">int</span> m_status;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">int</span> m_entry_status;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">int</span> m_id;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  std::list<std::shared_ptr<SequenceEntry> > m_entries;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">bool</span> m_muted;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">float</span> m_fps;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">float</span> m_speed_of_sound;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">float</span> m_doppler_factor;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> m_distance_model;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classAnimateableProperty.html">AnimateableProperty</a> m_volume;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="classAnimateableProperty.html">AnimateableProperty</a> m_location;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classAnimateableProperty.html">AnimateableProperty</a> m_orientation;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  std::recursive_mutex m_mutex;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">// delete copy constructor and operator=</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <a class="code" href="classSequenceData.html">SequenceData</a>(<span class="keyword">const</span> <a class="code" href="classSequenceData.html">SequenceData</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="classSequenceData.html">SequenceData</a>& operator=(<span class="keyword">const</span> <a class="code" href="classSequenceData.html">SequenceData</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="code" href="classSequenceData.html">SequenceData</a>(<a class="code" href="structSpecs.html">Specs</a> specs, <span class="keywordtype">float</span> fps, <span class="keywordtype">bool</span> muted);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">virtual</span> ~<a class="code" href="classSequenceData.html">SequenceData</a>();</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classILockable.html#abeb599754f0ca2fbbf5d6e944e2be0c9">lock</a>();</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classILockable.html#a23bf6c56ff6aeca84cec06919ca078f4">unlock</a>();</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="structSpecs.html">Specs</a> <a class="code" href="classSequenceReader.html#ab4dde1521f72c0ab699c14d27a9112af">getSpecs</a>();</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">void</span> setSpecs(<a class="code" href="structSpecs.html">Specs</a> specs);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">float</span> getFPS() <span class="keyword">const</span>;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">void</span> setFPS(<span class="keywordtype">float</span> fps);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordtype">void</span> mute(<span class="keywordtype">bool</span> muted);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keywordtype">bool</span> isMuted() <span class="keyword">const</span>;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">float</span> getSpeedOfSound() <span class="keyword">const</span>;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">void</span> setSpeedOfSound(<span class="keywordtype">float</span> speed);</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keywordtype">float</span> getDopplerFactor() <span class="keyword">const</span>;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keywordtype">void</span> setDopplerFactor(<span class="keywordtype">float</span> factor);</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <a class="code" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> getDistanceModel() <span class="keyword">const</span>;</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordtype">void</span> setDistanceModel(<a class="code" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> model);</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <a class="code" href="classAnimateableProperty.html">AnimateableProperty</a>* getAnimProperty(<a class="code" href="AnimateableProperty_8h.html#a88fcbc9d6d48a9832cc327f0b39cbec9">AnimateablePropertyType</a> type);</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  std::shared_ptr<SequenceEntry> add(std::shared_ptr<ISound> sound, <span class="keywordtype">float</span> begin, <span class="keywordtype">float</span> end, <span class="keywordtype">float</span> skip);</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="keywordtype">void</span> remove(std::shared_ptr<SequenceEntry> entry);</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> };</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <a class="code" href="Audaspace_8h.html#a4cf7088a9bb0256563f28fd13c80b066">AUD_NAMESPACE_END</a></div><div class="ttc" id="classSequenceReader_html"><div class="ttname"><a href="classSequenceReader.html">SequenceReader</a></div><div class="ttdoc">This reader plays back sequenced entries.</div><div class="ttdef"><b>Definition:</b> SequenceReader.h:36</div></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="classSequenceReader_html_ab4dde1521f72c0ab699c14d27a9112af"><div class="ttname"><a href="classSequenceReader.html#ab4dde1521f72c0ab699c14d27a9112af">SequenceReader::getSpecs</a></div><div class="ttdeci">virtual Specs getSpecs() const</div><div class="ttdoc">Returns the specification of the reader.</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="Specification_8h_html"><div class="ttname"><a href="Specification_8h.html">Specification.h</a></div><div class="ttdoc">Defines all important macros and basic data structures for stream format descriptions.</div></div> <div class="ttc" id="structSpecs_html"><div class="ttname"><a href="structSpecs.html">Specs</a></div><div class="ttdoc">Specification of a sound source.</div><div class="ttdef"><b>Definition:</b> Specification.h:109</div></div> <div class="ttc" id="classAnimateableProperty_html"><div class="ttname"><a href="classAnimateableProperty.html">AnimateableProperty</a></div><div class="ttdoc">This class saves animation data for float properties.</div><div class="ttdef"><b>Definition:</b> AnimateableProperty.h:46</div></div> <div class="ttc" id="classISound_html"><div class="ttname"><a href="classISound.html">ISound</a></div><div class="ttdoc">This class represents a type of sound source and saves the necessary values for it.</div><div class="ttdef"><b>Definition:</b> ISound.h:39</div></div> <div class="ttc" id="AnimateableProperty_8h_html"><div class="ttname"><a href="AnimateableProperty_8h.html">AnimateableProperty.h</a></div><div class="ttdoc">Defines the AnimateableProperty class as well as existing property types.</div></div> <div class="ttc" id="ILockable_8h_html"><div class="ttname"><a href="ILockable_8h.html">ILockable.h</a></div><div class="ttdoc">The ILockable interface.</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="I3DDevice_8h_html"><div class="ttname"><a href="I3DDevice_8h.html">I3DDevice.h</a></div><div class="ttdoc">Defines the I3DDevice interface as well as the different distance models.</div></div> <div class="ttc" id="classILockable_html"><div class="ttname"><a href="classILockable.html">ILockable</a></div><div class="ttdoc">This class provides an interface for lockable objects.</div><div class="ttdef"><b>Definition:</b> ILockable.h:33</div></div> <div class="ttc" id="classILockable_html_a23bf6c56ff6aeca84cec06919ca078f4"><div class="ttname"><a href="classILockable.html#a23bf6c56ff6aeca84cec06919ca078f4">ILockable::unlock</a></div><div class="ttdeci">virtual void unlock()=0</div><div class="ttdoc">Unlocks the previously locked object.</div></div> <div class="ttc" id="AnimateableProperty_8h_html_a88fcbc9d6d48a9832cc327f0b39cbec9"><div class="ttname"><a href="AnimateableProperty_8h.html#a88fcbc9d6d48a9832cc327f0b39cbec9">AnimateablePropertyType</a></div><div class="ttdeci">AnimateablePropertyType</div><div class="ttdoc">Possible animatable properties for Sequencer Factories and Entries.</div><div class="ttdef"><b>Definition:</b> AnimateableProperty.h:34</div></div> <div class="ttc" id="I3DDevice_8h_html_a5e42e9a2b2a31997de7556c983d15ffd"><div class="ttname"><a href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a></div><div class="ttdeci">DistanceModel</div><div class="ttdoc">Possible distance models for the 3D device.</div><div class="ttdef"><b>Definition:</b> I3DDevice.h:34</div></div> <div class="ttc" id="classSequenceData_html"><div class="ttname"><a href="classSequenceData.html">SequenceData</a></div><div class="ttdoc">This class represents sequenced entries to play a sound scene.</div><div class="ttdef"><b>Definition:</b> SequenceData.h:42</div></div> <div class="ttc" id="classSequenceEntry_html"><div class="ttname"><a href="classSequenceEntry.html">SequenceEntry</a></div><div class="ttdoc">This class represents a sequenced entry in a sequencer sound.</div><div class="ttdef"><b>Definition:</b> SequenceEntry.h:38</div></div> <div class="ttc" id="classILockable_html_abeb599754f0ca2fbbf5d6e944e2be0c9"><div class="ttname"><a href="classILockable.html#abeb599754f0ca2fbbf5d6e944e2be0c9">ILockable::lock</a></div><div class="ttdeci">virtual void lock()=0</div><div class="ttdoc">Locks the object.</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>