<!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/VolumeReader.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">VolumeReader.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="VolumeReader_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="IReader_8h.html">IReader.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="ISound_8h.html">ISound.h</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="VolumeStorage_8h.html">VolumeStorage.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="l00036"></a><span class="lineno"><a class="line" href="classVolumeReader.html"> 36</a></span> <span class="keyword">class </span><a class="code" href="Audaspace_8h.html#ad9080e3b9907fa3d0f5df561c65aa098">AUD_API</a> <a class="code" href="classVolumeReader.html">VolumeReader</a> : <span class="keyword">public</span> <a class="code" href="classIReader.html">IReader</a></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  std::shared_ptr<IReader> m_reader;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  std::shared_ptr<VolumeStorage> m_volumeStorage;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// delete copy constructor and operator=</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classVolumeReader.html">VolumeReader</a>(<span class="keyword">const</span> <a class="code" href="classVolumeReader.html">VolumeReader</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="classVolumeReader.html">VolumeReader</a>& operator=(<span class="keyword">const</span> <a class="code" href="classVolumeReader.html">VolumeReader</a>&) = <span class="keyword">delete</span>;</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> <span class="keyword">public</span>:</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="classVolumeReader.html">VolumeReader</a>(std::shared_ptr<IReader> reader, std::shared_ptr<VolumeStorage> volumeStorage);</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>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classIReader.html#acf13bbdc14e680c21122981f7d3bf6be">isSeekable</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classIReader.html#ad9fc74bb6f4c2b1ecc0f75b7118c1458">seek</a>(<span class="keywordtype">int</span> position);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIReader.html#a384465b5d988cc802702ae4bdc56ea85">getLength</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIReader.html#a47a8f86fd242a02ff626eb506cdb319d">getPosition</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">virtual</span> <a class="code" href="structSpecs.html">Specs</a> <a class="code" href="classIReader.html#aac4f3a14d42e5c4280488db98dd771b1">getSpecs</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classIReader.html#aef6fa21dfb71d3065fb14517bf0f24d5">read</a>(<span class="keywordtype">int</span>& length, <span class="keywordtype">bool</span>& eos, <a class="code" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a>* buffer);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> };</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <a class="code" href="Audaspace_8h.html#a4cf7088a9bb0256563f28fd13c80b066">AUD_NAMESPACE_END</a></div><div class="ttc" id="classIReader_html_a384465b5d988cc802702ae4bdc56ea85"><div class="ttname"><a href="classIReader.html#a384465b5d988cc802702ae4bdc56ea85">IReader::getLength</a></div><div class="ttdeci">virtual int getLength() const =0</div><div class="ttdoc">Returns an approximated length of the source in samples.</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="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="classIReader_html_ad9fc74bb6f4c2b1ecc0f75b7118c1458"><div class="ttname"><a href="classIReader.html#ad9fc74bb6f4c2b1ecc0f75b7118c1458">IReader::seek</a></div><div class="ttdeci">virtual void seek(int position)=0</div><div class="ttdoc">Seeks to a specific position in the source.</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="classIReader_html_aef6fa21dfb71d3065fb14517bf0f24d5"><div class="ttname"><a href="classIReader.html#aef6fa21dfb71d3065fb14517bf0f24d5">IReader::read</a></div><div class="ttdeci">virtual void read(int &length, bool &eos, sample_t *buffer)=0</div><div class="ttdoc">Request to read the next length samples out of the source.</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="classIReader_html_aac4f3a14d42e5c4280488db98dd771b1"><div class="ttname"><a href="classIReader.html#aac4f3a14d42e5c4280488db98dd771b1">IReader::getSpecs</a></div><div class="ttdeci">virtual Specs getSpecs() const =0</div><div class="ttdoc">Returns the specification of the reader.</div></div>
<div class="ttc" id="IReader_8h_html"><div class="ttname"><a href="IReader_8h.html">IReader.h</a></div><div class="ttdoc">The IReader interface.</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="classIReader_html_a47a8f86fd242a02ff626eb506cdb319d"><div class="ttname"><a href="classIReader.html#a47a8f86fd242a02ff626eb506cdb319d">IReader::getPosition</a></div><div class="ttdeci">virtual int getPosition() const =0</div><div class="ttdoc">Returns the position of the source as a sample count value.</div></div>
<div class="ttc" id="classIReader_html_acf13bbdc14e680c21122981f7d3bf6be"><div class="ttname"><a href="classIReader.html#acf13bbdc14e680c21122981f7d3bf6be">IReader::isSeekable</a></div><div class="ttdeci">virtual bool isSeekable() const =0</div><div class="ttdoc">Tells whether the source provides seeking functionality or not.</div></div>
<div class="ttc" id="VolumeStorage_8h_html"><div class="ttname"><a href="VolumeStorage_8h.html">VolumeStorage.h</a></div><div class="ttdoc">The VolumeStorage class.</div></div>
<div class="ttc" id="classVolumeReader_html"><div class="ttname"><a href="classVolumeReader.html">VolumeReader</a></div><div class="ttdoc">This class represents a reader for a sound that has its own shared volume.</div><div class="ttdef"><b>Definition:</b> VolumeReader.h:36</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
>
740
