-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSoundFileFactory_8hpp_source.htm
More file actions
158 lines (158 loc) · 20 KB
/
SoundFileFactory_8hpp_source.htm
File metadata and controls
158 lines (158 loc) · 20 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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<!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">SoundFileFactory.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_SOUNDFILEFACTORY_HPP</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define CPP3DS_SOUNDFILEFACTORY_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 <string></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <vector></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> <span class="keyword">class </span>SoundFileReader;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>SoundFileWriter;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classcpp3ds_1_1SoundFileFactory.htm"> 45</a></span> <span class="keyword">class </span><a class="code" href="classcpp3ds_1_1SoundFileFactory.htm">SoundFileFactory</a></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classcpp3ds_1_1SoundFileFactory.htm#a9a026687a9e229691a51c229f49a46e4">registerReader</a>();</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classcpp3ds_1_1SoundFileFactory.htm#a508a6fd112c770a11c5c9da1a417a418">unregisterReader</a>();</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classcpp3ds_1_1SoundFileFactory.htm#a9d362129230e41dd345e7868e821586a">registerWriter</a>();</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classcpp3ds_1_1SoundFileFactory.htm#a8a193c7e998f568d9329c80f3747ee82">unregisterWriter</a>();</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">static</span> <a class="code" href="classcpp3ds_1_1SoundFileReader.htm">SoundFileReader</a>* <a class="code" href="classcpp3ds_1_1SoundFileFactory.htm#abc627565643cb88827a2ea325cd4c86d">createReaderFromFilename</a>(<span class="keyword">const</span> std::string& filename);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">static</span> <a class="code" href="classcpp3ds_1_1SoundFileReader.htm">SoundFileReader</a>* <a class="code" href="classcpp3ds_1_1SoundFileFactory.htm#a0c52854ad0b8991de3a9dd16996b7e53">createReaderFromMemory</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, std::size_t sizeInBytes);</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">static</span> <a class="code" href="classcpp3ds_1_1SoundFileReader.htm">SoundFileReader</a>* <a class="code" href="classcpp3ds_1_1SoundFileFactory.htm#a81ca419d8d7a5b10b0aef878f2fcbc69">createReaderFromStream</a>(<a class="code" href="classcpp3ds_1_1InputStream.htm">InputStream</a>& stream);</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">static</span> <a class="code" href="classcpp3ds_1_1SoundFileWriter.htm">SoundFileWriter</a>* <a class="code" href="classcpp3ds_1_1SoundFileFactory.htm#a72a4455dd1f6c0d7ba90c30b93f85d4d">createWriterFromFilename</a>(<span class="keyword">const</span> std::string& filename);</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="comment">// Types</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"></span> <span class="keyword">struct </span>ReaderFactory</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  {</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  bool (*check)(<a class="code" href="classcpp3ds_1_1InputStream.htm">InputStream</a>&);</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <a class="code" href="classcpp3ds_1_1SoundFileReader.htm">SoundFileReader</a>* (*create)();</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  };</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keyword">typedef</span> std::vector<ReaderFactory> ReaderFactoryArray;</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">struct </span>WriterFactory</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  {</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  bool (*check)(<span class="keyword">const</span> std::string&);</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <a class="code" href="classcpp3ds_1_1SoundFileWriter.htm">SoundFileWriter</a>* (*create)();</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  };</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">typedef</span> std::vector<WriterFactory> WriterFactoryArray;</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="comment">// Static member data</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"></span> <span class="keyword">static</span> ReaderFactoryArray s_readers; </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keyword">static</span> WriterFactoryArray s_writers; </div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> };</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> } <span class="comment">// namespace cpp3ds</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="preprocessor">#include <cpp3ds/Audio/SoundFileFactory.inl></span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="preprocessor">#endif // CPP3DS_SOUNDFILEFACTORY_HPP</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="ttc" id="classcpp3ds_1_1SoundFileFactory_htm_a9d362129230e41dd345e7868e821586a"><div class="ttname"><a href="classcpp3ds_1_1SoundFileFactory.htm#a9d362129230e41dd345e7868e821586a">cpp3ds::SoundFileFactory::registerWriter</a></div><div class="ttdeci">static void registerWriter()</div><div class="ttdoc">Register a new writer. </div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileFactory_htm_a0c52854ad0b8991de3a9dd16996b7e53"><div class="ttname"><a href="classcpp3ds_1_1SoundFileFactory.htm#a0c52854ad0b8991de3a9dd16996b7e53">cpp3ds::SoundFileFactory::createReaderFromMemory</a></div><div class="ttdeci">static SoundFileReader * createReaderFromMemory(const void *data, std::size_t sizeInBytes)</div><div class="ttdoc">Instantiate the right codec for the given file in memory. </div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileWriter_htm"><div class="ttname"><a href="classcpp3ds_1_1SoundFileWriter.htm">cpp3ds::SoundFileWriter</a></div><div class="ttdoc">Abstract base class for sound file encoding. </div><div class="ttdef"><b>Definition:</b> <a href="SoundFileWriter_8hpp_source.htm#l00041">SoundFileWriter.hpp:41</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_1SoundFileFactory_htm_a508a6fd112c770a11c5c9da1a417a418"><div class="ttname"><a href="classcpp3ds_1_1SoundFileFactory.htm#a508a6fd112c770a11c5c9da1a417a418">cpp3ds::SoundFileFactory::unregisterReader</a></div><div class="ttdeci">static void unregisterReader()</div><div class="ttdoc">Unregister a reader. </div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileFactory_htm_a8a193c7e998f568d9329c80f3747ee82"><div class="ttname"><a href="classcpp3ds_1_1SoundFileFactory.htm#a8a193c7e998f568d9329c80f3747ee82">cpp3ds::SoundFileFactory::unregisterWriter</a></div><div class="ttdeci">static void unregisterWriter()</div><div class="ttdoc">Unregister a writer. </div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileFactory_htm_abc627565643cb88827a2ea325cd4c86d"><div class="ttname"><a href="classcpp3ds_1_1SoundFileFactory.htm#abc627565643cb88827a2ea325cd4c86d">cpp3ds::SoundFileFactory::createReaderFromFilename</a></div><div class="ttdeci">static SoundFileReader * createReaderFromFilename(const std::string &filename)</div><div class="ttdoc">Instantiate the right reader for the given file on disk. </div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileFactory_htm_a81ca419d8d7a5b10b0aef878f2fcbc69"><div class="ttname"><a href="classcpp3ds_1_1SoundFileFactory.htm#a81ca419d8d7a5b10b0aef878f2fcbc69">cpp3ds::SoundFileFactory::createReaderFromStream</a></div><div class="ttdeci">static SoundFileReader * createReaderFromStream(InputStream &stream)</div><div class="ttdoc">Instantiate the right codec for the given file in stream. </div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileFactory_htm_a9a026687a9e229691a51c229f49a46e4"><div class="ttname"><a href="classcpp3ds_1_1SoundFileFactory.htm#a9a026687a9e229691a51c229f49a46e4">cpp3ds::SoundFileFactory::registerReader</a></div><div class="ttdeci">static void registerReader()</div><div class="ttdoc">Register a new reader. </div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileFactory_htm"><div class="ttname"><a href="classcpp3ds_1_1SoundFileFactory.htm">cpp3ds::SoundFileFactory</a></div><div class="ttdoc">Manages and instantiates sound file readers and writers. </div><div class="ttdef"><b>Definition:</b> <a href="SoundFileFactory_8hpp_source.htm#l00045">SoundFileFactory.hpp:45</a></div></div>
<div class="ttc" id="classcpp3ds_1_1SoundFileFactory_htm_a72a4455dd1f6c0d7ba90c30b93f85d4d"><div class="ttname"><a href="classcpp3ds_1_1SoundFileFactory.htm#a72a4455dd1f6c0d7ba90c30b93f85d4d">cpp3ds::SoundFileFactory::createWriterFromFilename</a></div><div class="ttdeci">static SoundFileWriter * createWriterFromFilename(const std::string &filename)</div><div class="ttdoc">Instantiate the right writer for the given file on disk. </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>