<!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: libsndfile/SndFileReader.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_1e60f77674db49603f90ecbfafaa8328.html">libsndfile</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">SndFileReader.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="SndFileReader_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">#include "<a class="code" href="IReader_8h.html">IReader.h</a>"</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifdef LIBSNDFILE_PLUGIN</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define AUD_BUILD_PLUGIN</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <sndfile.h></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <a class="code" href="Audaspace_8h.html#acd7584504197a1397aaf57af797e1813">AUD_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span><a class="code" href="classBuffer.html">Buffer</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="classSndFileReader.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="Audaspace_8h.html#ae80c5c0f6ce55934dfa1823d908fa25f">AUD_PLUGIN_API</a> <a class="code" href="classSndFileReader.html">SndFileReader</a> : <span class="keyword">public</span> <a class="code" href="classIReader.html">IReader</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">private</span>:</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">int</span> m_position;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">int</span> m_length;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">bool</span> m_seekable;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="structSpecs.html">Specs</a> m_specs;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  SNDFILE* m_sndfile;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  SF_VIRTUAL_IO m_vio;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  std::shared_ptr<Buffer> m_membuffer;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">int</span> m_memoffset;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// Functions for libsndfile virtual IO functionality</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="Audaspace_8h.html#acd0b288d4edf8e15c0221b416faa79c6">AUD_LOCAL</a> <span class="keyword">static</span> sf_count_t vio_get_filelen(<span class="keywordtype">void</span>* user_data);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="Audaspace_8h.html#acd0b288d4edf8e15c0221b416faa79c6">AUD_LOCAL</a> <span class="keyword">static</span> sf_count_t vio_seek(sf_count_t offset, <span class="keywordtype">int</span> whence, <span class="keywordtype">void</span>* user_data);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="Audaspace_8h.html#acd0b288d4edf8e15c0221b416faa79c6">AUD_LOCAL</a> <span class="keyword">static</span> sf_count_t vio_read(<span class="keywordtype">void</span>* ptr, sf_count_t count, <span class="keywordtype">void</span>* user_data);</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> sf_count_t vio_tell(<span class="keywordtype">void</span>* user_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>  <span class="comment">// delete copy constructor and operator=</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="classSndFileReader.html">SndFileReader</a>(<span class="keyword">const</span> <a class="code" href="classSndFileReader.html">SndFileReader</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="classSndFileReader.html">SndFileReader</a>& operator=(<span class="keyword">const</span> <a class="code" href="classSndFileReader.html">SndFileReader</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="classSndFileReader.html">SndFileReader</a>(std::string filename);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <a class="code" href="classSndFileReader.html">SndFileReader</a>(std::shared_ptr<Buffer> buffer);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">virtual</span> ~<a class="code" href="classSndFileReader.html">SndFileReader</a>();</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</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="l00118"></a><span class="lineno"> 118</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="l00119"></a><span class="lineno"> 119</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="l00120"></a><span class="lineno"> 120</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="l00121"></a><span class="lineno"> 121</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="l00122"></a><span class="lineno"> 122</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="l00123"></a><span class="lineno"> 123</span> };</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</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="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="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="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="classSndFileReader_html"><div class="ttname"><a href="classSndFileReader.html">SndFileReader</a></div><div class="ttdoc">This class reads a sound file via libsndfile.</div><div class="ttdef"><b>Definition:</b> SndFileReader.h:42</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="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="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="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><!-- 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
>
632
