<!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: jack/JackDevice.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_768b9b14c1d73c4aafb6a52b1268efd9.html">jack</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">JackDevice.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="JackDevice_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="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifdef JACK_PLUGIN</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define AUD_BUILD_PLUGIN</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="JackSynchronizer_8h.html">JackSynchronizer.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="SoftwareDevice_8h.html">devices/SoftwareDevice.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="Buffer_8h.html">util/Buffer.h</a>"</span></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="preprocessor">#include <string></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <condition_variable></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <thread></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <jack/jack.h></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <jack/ringbuffer.h></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> <a class="code" href="Audaspace_8h.html#acd7584504197a1397aaf57af797e1813">AUD_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classJackDevice.html"> 44</a></span> <span class="keyword">class </span><a class="code" href="Audaspace_8h.html#ae80c5c0f6ce55934dfa1823d908fa25f">AUD_PLUGIN_API</a> <a class="code" href="classJackDevice.html">JackDevice</a> : <span class="keyword">public</span> <a class="code" href="classSoftwareDevice.html">SoftwareDevice</a></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">private</span>:</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  jack_port_t** m_ports;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  jack_client_t* m_client;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="classBuffer.html">Buffer</a> m_buffer;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classBuffer.html">Buffer</a> m_deinterleavebuf;</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>  jack_ringbuffer_t** m_ringbuffers;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">bool</span> m_valid;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classJackSynchronizer.html">JackSynchronizer</a> m_synchronizer;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="Audaspace_8h.html#acd0b288d4edf8e15c0221b416faa79c6">AUD_LOCAL</a> <span class="keyword">static</span> <span class="keywordtype">void</span> jack_shutdown(<span class="keywordtype">void</span>* data);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <a class="code" href="Audaspace_8h.html#acd0b288d4edf8e15c0221b416faa79c6">AUD_LOCAL</a> <span class="keyword">static</span> <span class="keywordtype">int</span> jack_mix(jack_nframes_t length, <span class="keywordtype">void</span>* data);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="Audaspace_8h.html#acd0b288d4edf8e15c0221b416faa79c6">AUD_LOCAL</a> <span class="keyword">static</span> <span class="keywordtype">int</span> jack_sync(jack_transport_state_t state, jack_position_t* pos, <span class="keywordtype">void</span>* data);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  jack_transport_state_t m_nextState;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  jack_transport_state_t m_state;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">int</span> m_sync;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classISynchronizer.html#a055d3b6aeda93fd20f87b2ff08c5fa04">ISynchronizer::syncFunction</a> m_syncFunc;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">void</span>* m_syncFuncData;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  std::thread m_mixingThread;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  std::mutex m_mixingLock;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  std::condition_variable m_mixingCondition;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <a class="code" href="Audaspace_8h.html#acd0b288d4edf8e15c0221b416faa79c6">AUD_LOCAL</a> <span class="keywordtype">void</span> updateRingBuffers();</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="comment">// delete copy constructor and operator=</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <a class="code" href="classJackDevice.html">JackDevice</a>(<span class="keyword">const</span> <a class="code" href="classJackDevice.html">JackDevice</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <a class="code" href="classJackDevice.html">JackDevice</a>& operator=(<span class="keyword">const</span> <a class="code" href="classJackDevice.html">JackDevice</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classSoftwareDevice.html#af536b44463d8d18d611d448e8b733173">playing</a>(<span class="keywordtype">bool</span> playing);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <a class="code" href="classJackDevice.html">JackDevice</a>(std::string name, <a class="code" href="structDeviceSpecs.html">DeviceSpecs</a> specs, <span class="keywordtype">int</span> buffersize = <a class="code" href="Audaspace_8h.html#a1e55fb9a74622cab4aba3656fc1d25ce">AUD_DEFAULT_BUFFER_SIZE</a>);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keyword">virtual</span> ~<a class="code" href="classJackDevice.html">JackDevice</a>();</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keyword">virtual</span> <a class="code" href="classISynchronizer.html">ISynchronizer</a>* <a class="code" href="classSoftwareDevice.html#a494e54c82905f5f97f770a3a352bec88">getSynchronizer</a>();</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordtype">void</span> startPlayback();</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keywordtype">void</span> stopPlayback();</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="keywordtype">void</span> seekPlayback(<span class="keywordtype">float</span> time);</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordtype">void</span> setSyncCallback(<a class="code" href="classISynchronizer.html#a055d3b6aeda93fd20f87b2ff08c5fa04">ISynchronizer::syncFunction</a> sync, <span class="keywordtype">void</span>* data);</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="keywordtype">float</span> getPlaybackPosition();</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <span class="keywordtype">bool</span> doesPlayback();</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> registerPlugin();</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> };</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00204"></a><span class="lineno"> 204</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="classISynchronizer_html"><div class="ttname"><a href="classISynchronizer.html">ISynchronizer</a></div><div class="ttdoc">This class enables global synchronization of several audio applications if supported.</div><div class="ttdef"><b>Definition:</b> ISynchronizer.h:38</div></div>
<div class="ttc" id="classSoftwareDevice_html_a494e54c82905f5f97f770a3a352bec88"><div class="ttname"><a href="classSoftwareDevice.html#a494e54c82905f5f97f770a3a352bec88">SoftwareDevice::getSynchronizer</a></div><div class="ttdeci">virtual ISynchronizer * getSynchronizer()</div><div class="ttdoc">Retrieves the synchronizer for this device, which enables accurate synchronization between audio play...</div></div>
<div class="ttc" id="Audaspace_8h_html_a1e55fb9a74622cab4aba3656fc1d25ce"><div class="ttname"><a href="Audaspace_8h.html#a1e55fb9a74622cab4aba3656fc1d25ce">AUD_DEFAULT_BUFFER_SIZE</a></div><div class="ttdeci">#define AUD_DEFAULT_BUFFER_SIZE</div><div class="ttdoc">The default playback buffer size of a device.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:103</div></div>
<div class="ttc" id="classJackDevice_html"><div class="ttname"><a href="classJackDevice.html">JackDevice</a></div><div class="ttdoc">This device plays back through JACK.</div><div class="ttdef"><b>Definition:</b> JackDevice.h:44</div></div>
<div class="ttc" id="JackSynchronizer_8h_html"><div class="ttname"><a href="JackSynchronizer_8h.html">JackSynchronizer.h</a></div><div class="ttdoc">The JackSynchronizer class.</div></div>
<div class="ttc" id="classSoftwareDevice_html_af536b44463d8d18d611d448e8b733173"><div class="ttname"><a href="classSoftwareDevice.html#af536b44463d8d18d611d448e8b733173">SoftwareDevice::playing</a></div><div class="ttdeci">virtual void playing(bool playing)=0</div><div class="ttdoc">This function tells the device, to start or pause playback.</div></div>
<div class="ttc" id="classISynchronizer_html_a055d3b6aeda93fd20f87b2ff08c5fa04"><div class="ttname"><a href="classISynchronizer.html#a055d3b6aeda93fd20f87b2ff08c5fa04">ISynchronizer::syncFunction</a></div><div class="ttdeci">void(* syncFunction)(void *, int, float)</div><div class="ttdoc">The syncFunction is called when a synchronization event happens.</div><div class="ttdef"><b>Definition:</b> ISynchronizer.h:52</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="classJackSynchronizer_html"><div class="ttname"><a href="classJackSynchronizer.html">JackSynchronizer</a></div><div class="ttdoc">This class is a Synchronizer implementation using JACK Transport.</div><div class="ttdef"><b>Definition:</b> JackSynchronizer.h:38</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="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="Audaspace_8h_html_ae80c5c0f6ce55934dfa1823d908fa25f"><div class="ttname"><a href="Audaspace_8h.html#ae80c5c0f6ce55934dfa1823d908fa25f">AUD_PLUGIN_API</a></div><div class="ttdeci">#define AUD_PLUGIN_API</div><div class="ttdoc">Used for exporting symbols in the shared library.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:94</div></div>
<div class="ttc" id="classSoftwareDevice_html"><div class="ttname"><a href="classSoftwareDevice.html">SoftwareDevice</a></div><div class="ttdoc">The software device is a generic device with software mixing.</div><div class="ttdef"><b>Definition:</b> SoftwareDevice.h:51</div></div>
<div class="ttc" id="Audaspace_8h_html_acd0b288d4edf8e15c0221b416faa79c6"><div class="ttname"><a href="Audaspace_8h.html#acd0b288d4edf8e15c0221b416faa79c6">AUD_LOCAL</a></div><div class="ttdeci">#define AUD_LOCAL</div><div class="ttdoc">Used for hiding symbols from export in the shared library.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:80</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="SoftwareDevice_8h_html"><div class="ttname"><a href="SoftwareDevice_8h.html">SoftwareDevice.h</a></div><div class="ttdoc">The SoftwareDevice class.</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>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
423
