mirror of https://github.com/AxioDL/amuse.git
121 lines
14 KiB
HTML
121 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
|
|
<title>Amuse: README.md 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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">Amuse
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('_r_e_a_d_m_e_8md.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="headertitle">
|
|
<div class="title">README.md</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> ### Amuse {#mainpage}</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> **Amuse** is a real-time MIDI and SFX sequencer, with basic effects, </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> 3D positional audio and surround-output capabilities.</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> The project is designed for compatibility with Audio Groups and Song data</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> found in PC/N64/GCN/GBA games using the *MusyX* audio engine; providing an</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> alternate runtime library to use for sequencing these games' audio libraries.</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> #### Library</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> The Amuse API exposes full interactivity between a client application</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> (game engine) and the sequencer engine. Unlike the interrupt-driven nature</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> of the original console implementations (where the audio chip 'requests' more</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> audio as needed), Amuse is entirely synchronous. This means the client must</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> periodically *pump* the audio engine (typically once per video frame) to keep</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> the OS' audio system fed.</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> The client must provide the implementation for allocating and mixing audio</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> voices, since this may drastically differ from target to target.</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> `amuse::IBackendVoiceAllocator` is the pure-virtual interface to implement</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> for this. Alternatively, if [Boo](https://github.com/AxioDL/boo) is present</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> in the CMake project tree, Amuse will be compiled with a backend supporting</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> multiple popular low-level audio APIs. Windows, OS X, and Linux all have</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> excellent support this way.</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> Here's an example usage:</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> ```cpp</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> #include <amuse/amuse.hpp></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> #include "MyVoiceAllocator.hpp"</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> #include "MyAudioGroupLoader.hpp"</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> int main(int argc, char* argv[])</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>  /* Up to the client to implement voice allocation and mixing */</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  std::unique_ptr<amuse::IBackendVoiceAllocator> voxAlloc = MakeMyVoiceAllocator();</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>  /* Application just needs one per audio output (not per channel) */</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  amuse::Engine snd(*voxAlloc);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  /* An 'AudioGroup' is an atomically-loadable unit within Amuse. </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  * A client-assigned integer serves as the handle to the group once loaded</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  */</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  amuse::IntrusiveAudioGroupData data = LoadMyAudioGroup();</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  snd.addAudioGroup(data);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  /* Starting a SoundMacro playing is accomplished like so: */</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  int sfxId = 0x1337;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  float vol = 1.0f;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  float pan = 0.0f;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  std::shared_ptr<Voice> voice = snd.fxStart(sfxId, vol, pan);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  /* Play for ~5 sec */</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  int passedFrames = 0;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  while (passedFrames < 300)</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  snd.pumpEngine();</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  ++passedFrames;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  WaitForVSync();</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  /* Stopping a SoundMacro is accomplished by sending a</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  * MIDI-style 'KeyOff' message for the voice</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  */</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  voice->keyOff();</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  /* Play for 2 more seconds to allow the macro to gracefully fade-out */</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  passedFrames = 0;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  while (passedFrames < 120)</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  snd.pumpEngine();</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  ++passedFrames;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  WaitForVSync();</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  /* Clean up and exit */</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  return 0;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> ```</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> #### Tool</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> In addition to the library, a command-line tool for performing various pipeline</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> tasks is provided. Compilers for audio groups and song data, as well as basic</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> playback functionality is available via the tool.</div></div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><b>README.md</b></li>
|
|
<li class="footer">Generated on Wed May 18 2016 20:05:19 for Amuse by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|