-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSoundFileReader_8hpp_source.htm
More file actions
127 lines (127 loc) · 15.6 KB
/
SoundFileReader_8hpp_source.htm
File metadata and controls
127 lines (127 loc) · 15.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<!doctype html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpp3ds · Documentation</title>
<link rel="stylesheet" href="../css/app.css" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script src="../bower_components/modernizr/modernizr.js"></script>
</head>
<body>
<div id="topnav" class="text-center">
<dl class="sub-nav">
<dd id="navlogo"><a href="/">
<img src="../img/logo.svg" />
</a></dd>
<dd><a href="/#what">What is it?</a></dd>
<dd><a href="/#download">Download</a></dd>
<dd><a href="/#faqs">FAQs</a></dd>
<dd class="active"><a href="/docs">Docs</a></dd>
</dl>
</div>
<div id="content">
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="modules.htm"><span>Modules</span></a></li>
<li><a href="annotated.htm"><span>Classes</span></a></li>
<li class="current"><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.htm"><span>File List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_0b93ed46ee854382aab85c778b89946e.htm">include</a></li><li class="navelem"><a class="el" href="dir_18d409fe281a3b15bd325ab753ead42a.htm">cpp3ds</a></li><li class="navelem"><a class="el" href="dir_f11191753e0b9218936d11d72560cde3.htm">Audio</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">SoundFileReader.hpp</div> </div>
</div><!--header-->
<div class="contents">
<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="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SFML - Simple and Fast Multimedia Library</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (C) 2007-2015 Laurent Gomila ([email protected])</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// subject to the following restrictions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">//</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// 1. The origin of this software must not be misrepresented;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// you must not claim that you wrote the original software.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// If you use this software in a product, an acknowledgment</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// in the product documentation would be appreciated but is not required.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// 2. Altered source versions must be plainly marked as such,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// and must not be misrepresented as being the original software.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">//</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">//</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef CPP3DS_SOUNDFILEREADER_HPP</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define CPP3DS_SOUNDFILEREADER_HPP</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Headers</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span><span class="preprocessor">#include <cpp3ds/Config.hpp></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <string></span></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> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span><a class="code" href="namespacecpp3ds.htm">cpp3ds</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>InputStream;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1SoundFileReader.htm"> 43</a></span> <span class="keyword">class </span><a class="code" href="classcpp3ds_1_1SoundFileReader.htm">SoundFileReader</a></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> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structcpp3ds_1_1SoundFileReader_1_1Info.htm"> 51</a></span>  <span class="keyword">struct </span><a class="code" href="structcpp3ds_1_1SoundFileReader_1_1Info.htm">Info</a></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  {</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structcpp3ds_1_1SoundFileReader_1_1Info.htm#a943dd6b77e7d187378d17a077b65230e"> 53</a></span>  Uint64 <a class="code" href="structcpp3ds_1_1SoundFileReader_1_1Info.htm#a943dd6b77e7d187378d17a077b65230e">sampleCount</a>; </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structcpp3ds_1_1SoundFileReader_1_1Info.htm#a451d6da88e11c81cffd631a4a1be39ba"> 54</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structcpp3ds_1_1SoundFileReader_1_1Info.htm#a451d6da88e11c81cffd631a4a1be39ba">channelCount</a>; </div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structcpp3ds_1_1SoundFileReader_1_1Info.htm#a792dda92e279d01ae3d9a6ec264aa076"> 55</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structcpp3ds_1_1SoundFileReader_1_1Info.htm#a792dda92e279d01ae3d9a6ec264aa076">sampleRate</a>; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  };</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1SoundFileReader.htm#a1561b6a5bac1344a5490c43e5f88ef46"> 62</a></span>  <span class="keyword">virtual</span> <a class="code" href="classcpp3ds_1_1SoundFileReader.htm#a1561b6a5bac1344a5490c43e5f88ef46">~SoundFileReader</a>() {}</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classcpp3ds_1_1SoundFileReader.htm#a4ac14f109a497bb72cd6f8324f611ab8">open</a>(<a class="code" href="classcpp3ds_1_1InputStream.htm">InputStream</a>& stream, Info& info) = 0;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcpp3ds_1_1SoundFileReader.htm#a9dca75c09bdc6a540e36f4d9bf3b80e8">seek</a>(Uint64 sampleOffset) = 0;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">virtual</span> Uint64 <a class="code" href="classcpp3ds_1_1SoundFileReader.htm#ab8f265778f4603e15aeb89cf183106fe">read</a>(Int16* samples, Uint64 maxCount) = 0;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> };</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> } <span class="comment">// namespace cpp3ds</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#endif // CPP3DS_SOUNDFILEREADER_HPP</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="ttc" id="structcpp3ds_1_1SoundFileReader_1_1Info_htm_a943dd6b77e7d187378d17a077b65230e"><div class="ttname"><a href="structcpp3ds_1_1SoundFileReader_1_1Info.htm#a943dd6b77e7d187378d17a077b65230e">cpp3ds::SoundFileReader::Info::sampleCount</a></div><div class="ttdeci">Uint64 sampleCount</div><div class="ttdoc">Total number of samples in the file. </div><div class="ttdef"><b>Definition:</b> <a href="SoundFileReader_8hpp_source.htm#l00053">SoundFileReader.hpp:53</a></div></div>
<div class="ttc" id="classcpp3ds_1_1InputStream_htm"><div class="ttname"><a href="classcpp3ds_1_1InputStream.htm">cpp3ds::InputStream</a></div><div class="ttdoc">Abstract class for custom file input streams. </div><div class="ttdef"><b>Definition:</b> <a href="InputStream_8hpp_source.htm#l00040">InputStream.hpp:40</a></div></div>
<div class="ttc" id="namespacecpp3ds_htm"><div class="ttname"><a href="namespacecpp3ds.htm">cpp3ds</a></div><div class="ttdef"><b>Definition:</b> <a href="AlResource_8hpp_source.htm#l00033">AlResource.hpp:33</a></div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileReader_htm_ab8f265778f4603e15aeb89cf183106fe"><div class="ttname"><a href="classcpp3ds_1_1SoundFileReader.htm#ab8f265778f4603e15aeb89cf183106fe">cpp3ds::SoundFileReader::read</a></div><div class="ttdeci">virtual Uint64 read(Int16 *samples, Uint64 maxCount)=0</div><div class="ttdoc">Read audio samples from the open file. </div></div>
<div class="ttc" id="structcpp3ds_1_1SoundFileReader_1_1Info_htm_a792dda92e279d01ae3d9a6ec264aa076"><div class="ttname"><a href="structcpp3ds_1_1SoundFileReader_1_1Info.htm#a792dda92e279d01ae3d9a6ec264aa076">cpp3ds::SoundFileReader::Info::sampleRate</a></div><div class="ttdeci">unsigned int sampleRate</div><div class="ttdoc">Samples rate of the sound, in samples per second. </div><div class="ttdef"><b>Definition:</b> <a href="SoundFileReader_8hpp_source.htm#l00055">SoundFileReader.hpp:55</a></div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileReader_htm_a4ac14f109a497bb72cd6f8324f611ab8"><div class="ttname"><a href="classcpp3ds_1_1SoundFileReader.htm#a4ac14f109a497bb72cd6f8324f611ab8">cpp3ds::SoundFileReader::open</a></div><div class="ttdeci">virtual bool open(InputStream &stream, Info &info)=0</div><div class="ttdoc">Open a sound file for reading. </div></div>
<div class="ttc" id="structcpp3ds_1_1SoundFileReader_1_1Info_htm_a451d6da88e11c81cffd631a4a1be39ba"><div class="ttname"><a href="structcpp3ds_1_1SoundFileReader_1_1Info.htm#a451d6da88e11c81cffd631a4a1be39ba">cpp3ds::SoundFileReader::Info::channelCount</a></div><div class="ttdeci">unsigned int channelCount</div><div class="ttdoc">Number of channels of the sound. </div><div class="ttdef"><b>Definition:</b> <a href="SoundFileReader_8hpp_source.htm#l00054">SoundFileReader.hpp:54</a></div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileReader_htm_a9dca75c09bdc6a540e36f4d9bf3b80e8"><div class="ttname"><a href="classcpp3ds_1_1SoundFileReader.htm#a9dca75c09bdc6a540e36f4d9bf3b80e8">cpp3ds::SoundFileReader::seek</a></div><div class="ttdeci">virtual void seek(Uint64 sampleOffset)=0</div><div class="ttdoc">Change the current read position to the given sample offset. </div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileReader_htm_a1561b6a5bac1344a5490c43e5f88ef46"><div class="ttname"><a href="classcpp3ds_1_1SoundFileReader.htm#a1561b6a5bac1344a5490c43e5f88ef46">cpp3ds::SoundFileReader::~SoundFileReader</a></div><div class="ttdeci">virtual ~SoundFileReader()</div><div class="ttdoc">Virtual destructor. </div><div class="ttdef"><b>Definition:</b> <a href="SoundFileReader_8hpp_source.htm#l00062">SoundFileReader.hpp:62</a></div></div>
<div class="ttc" id="structcpp3ds_1_1SoundFileReader_1_1Info_htm"><div class="ttname"><a href="structcpp3ds_1_1SoundFileReader_1_1Info.htm">cpp3ds::SoundFileReader::Info</a></div><div class="ttdoc">Structure holding the audio properties of a sound file. </div><div class="ttdef"><b>Definition:</b> <a href="SoundFileReader_8hpp_source.htm#l00051">SoundFileReader.hpp:51</a></div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileReader_htm"><div class="ttname"><a href="classcpp3ds_1_1SoundFileReader.htm">cpp3ds::SoundFileReader</a></div><div class="ttdoc">Abstract base class for sound file decoding. </div><div class="ttdef"><b>Definition:</b> <a href="SoundFileReader_8hpp_source.htm#l00043">SoundFileReader.hpp:43</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML Copyright © Laurent Gomila
</div>
</div>
</body>
</html>