<!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: respec/Mixer.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_f765346efce1a3a011bd69b313493e3c.html">respec</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">Mixer.h</div> </div> </div><!--header--> <div class="contents"> <a href="Mixer_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="ConverterFunctions_8h.html">respec/ConverterFunctions.h</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="Buffer_8h.html">util/Buffer.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> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <a class="code" href="Audaspace_8h.html#acd7584504197a1397aaf57af797e1813">AUD_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span><a class="code" href="classIReader.html">IReader</a>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classMixer.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="Audaspace_8h.html#ad9080e3b9907fa3d0f5df561c65aa098">AUD_API</a> <a class="code" href="classMixer.html">Mixer</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">private</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// delete copy constructor and operator=</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classMixer.html">Mixer</a>(<span class="keyword">const</span> <a class="code" href="classMixer.html">Mixer</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="classMixer.html">Mixer</a>& operator=(<span class="keyword">const</span> <a class="code" href="classMixer.html">Mixer</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classMixer.html#aafc2af1ded09f70b46bedf5bda61c9e7"> 50</a></span>  <a class="code" href="structDeviceSpecs.html">DeviceSpecs</a> <a class="code" href="classMixer.html#aafc2af1ded09f70b46bedf5bda61c9e7">m_specs</a>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classMixer.html#af7785bad904c3c077c58d01006f853d1"> 55</a></span>  <span class="keywordtype">int</span> <a class="code" href="classMixer.html#af7785bad904c3c077c58d01006f853d1">m_length</a>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classMixer.html#accd6dacc547ead5dd8212444f5237a05"> 60</a></span>  <a class="code" href="classBuffer.html">Buffer</a> <a class="code" href="classMixer.html#accd6dacc547ead5dd8212444f5237a05">m_buffer</a>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classMixer.html#acd5d4ced7001113d22b6b220c25e676a"> 65</a></span>  <a class="code" href="ConverterFunctions_8h.html#a41110c0f525b0511ec00d4e6559b7662">convert_f</a> <a class="code" href="classMixer.html#acd5d4ced7001113d22b6b220c25e676a">m_convert</a>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="classMixer.html">Mixer</a>(<a class="code" href="structDeviceSpecs.html">DeviceSpecs</a> specs);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classMixer.html#af8db94e968ba1a3e03ffe9e377e0d6e9"> 76</a></span>  <span class="keyword">virtual</span> <a class="code" href="classMixer.html#af8db94e968ba1a3e03ffe9e377e0d6e9">~Mixer</a>() {}</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="structDeviceSpecs.html">DeviceSpecs</a> getSpecs() <span class="keyword">const</span>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> setSpecs(<a class="code" href="structSpecs.html">Specs</a> specs);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> mix(<a class="code" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a>* buffer, <span class="keywordtype">int</span> start, <span class="keywordtype">int</span> length, <span class="keywordtype">float</span> volume);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">void</span> mix(<a class="code" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a>* buffer, <span class="keywordtype">int</span> start, <span class="keywordtype">int</span> length, <span class="keywordtype">float</span> volume_to, <span class="keywordtype">float</span> volume_from);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">void</span> read(<a class="code" href="Audaspace_8h.html#ae91c9d70e1e2c8b657e51de1fff60ada">data_t</a>* buffer, <span class="keywordtype">float</span> volume);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordtype">void</span> clear(<span class="keywordtype">int</span> length);</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> };</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</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="classIReader_html"><div class="ttname"><a href="classIReader.html">IReader</a></div><div class="ttdoc">This class represents a sound source as stream or as buffer which can be read for example by another ...</div><div class="ttdef"><b>Definition:</b> IReader.h:34</div></div> <div class="ttc" id="classMixer_html"><div class="ttname"><a href="classMixer.html">Mixer</a></div><div class="ttdoc">This abstract class is able to mix audiosignals with same channel count and sample rate and convert i...</div><div class="ttdef"><b>Definition:</b> Mixer.h:39</div></div> <div class="ttc" id="classMixer_html_aafc2af1ded09f70b46bedf5bda61c9e7"><div class="ttname"><a href="classMixer.html#aafc2af1ded09f70b46bedf5bda61c9e7">Mixer::m_specs</a></div><div class="ttdeci">DeviceSpecs m_specs</div><div class="ttdoc">The output specification.</div><div class="ttdef"><b>Definition:</b> Mixer.h:50</div></div> <div class="ttc" id="classMixer_html_accd6dacc547ead5dd8212444f5237a05"><div class="ttname"><a href="classMixer.html#accd6dacc547ead5dd8212444f5237a05">Mixer::m_buffer</a></div><div class="ttdeci">Buffer m_buffer</div><div class="ttdoc">The mixing buffer.</div><div class="ttdef"><b>Definition:</b> Mixer.h:60</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="ConverterFunctions_8h_html_a41110c0f525b0511ec00d4e6559b7662"><div class="ttname"><a href="ConverterFunctions_8h.html#a41110c0f525b0511ec00d4e6559b7662">convert_f</a></div><div class="ttdeci">void(* convert_f)(data_t *target, data_t *source, int length)</div><div class="ttdoc">The function template for functions converting from one sample format to another, having the same par...</div><div class="ttdef"><b>Definition:</b> ConverterFunctions.h:35</div></div> <div class="ttc" id="Audaspace_8h_html_ae91c9d70e1e2c8b657e51de1fff60ada"><div class="ttname"><a href="Audaspace_8h.html#ae91c9d70e1e2c8b657e51de1fff60ada">data_t</a></div><div class="ttdeci">unsigned char data_t</div><div class="ttdoc">Sample data type (format samples)</div><div class="ttdef"><b>Definition:</b> Audaspace.h:129</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="classBuffer_html"><div class="ttname"><a href="classBuffer.html">Buffer</a></div><div class="ttdoc">This class is a simple buffer in RAM which is 32 Byte aligned and provides resize functionality.</div><div class="ttdef"><b>Definition:</b> Buffer.h:33</div></div> <div class="ttc" id="structDeviceSpecs_html"><div class="ttname"><a href="structDeviceSpecs.html">DeviceSpecs</a></div><div class="ttdoc">Specification of a sound device.</div><div class="ttdef"><b>Definition:</b> Specification.h:119</div></div> <div class="ttc" id="ConverterFunctions_8h_html"><div class="ttname"><a href="ConverterFunctions_8h.html">ConverterFunctions.h</a></div><div class="ttdoc">Defines several conversion functions between different sample formats.</div></div> <div class="ttc" id="classMixer_html_af8db94e968ba1a3e03ffe9e377e0d6e9"><div class="ttname"><a href="classMixer.html#af8db94e968ba1a3e03ffe9e377e0d6e9">Mixer::~Mixer</a></div><div class="ttdeci">virtual ~Mixer()</div><div class="ttdoc">Destroys the mixer.</div><div class="ttdef"><b>Definition:</b> Mixer.h:76</div></div> <div class="ttc" id="Audaspace_8h_html_aa0798f7ea0975b143a1d9deac8c05d43"><div class="ttname"><a href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a></div><div class="ttdeci">float sample_t</div><div class="ttdoc">Sample type.(float samples)</div><div class="ttdef"><b>Definition:</b> Audaspace.h:126</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="Buffer_8h_html"><div class="ttname"><a href="Buffer_8h.html">Buffer.h</a></div><div class="ttdoc">The Buffer class.</div></div> <div class="ttc" id="classMixer_html_acd5d4ced7001113d22b6b220c25e676a"><div class="ttname"><a href="classMixer.html#acd5d4ced7001113d22b6b220c25e676a">Mixer::m_convert</a></div><div class="ttdeci">convert_f m_convert</div><div class="ttdoc">Converter function.</div><div class="ttdef"><b>Definition:</b> Mixer.h:65</div></div> <div class="ttc" id="classMixer_html_af7785bad904c3c077c58d01006f853d1"><div class="ttname"><a href="classMixer.html#af7785bad904c3c077c58d01006f853d1">Mixer::m_length</a></div><div class="ttdeci">int m_length</div><div class="ttdoc">The length of the mixing buffer.</div><div class="ttdef"><b>Definition:</b> Mixer.h:55</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>