aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/sound__driver__al_8h-source.html
blob: 22284f6cb4ee5091c01a50b5832a19578bfe7320 (plain)
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
	<TITLE>nevrax.org : docs</TITLE>
	<LINK REL=stylesheet TYPE="text/css" HREF="/inc/css/nevrax.css">
	<link href="doxygen.css" rel="stylesheet" type="text/css">
</HEAD>
<BODY MARGINHEIGHT="0" MARGINWIDTH="0">

<!-- uplinks -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0>
 <TR>
        <TD WIDTH=16><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD WIDTH=140 BGCOLOR=#dddddd><IMG  SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD WIDTH=16><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD><IMG width=6 height=14 SRC="/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF='/'><b>Home</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
        <TD><IMG  width=6 height=14  SRC="/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF='/'><b>nevrax.com</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
 </TR>
</TABLE> 

<!-- banner Nevrax -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0 WIDTH=100%>
 <TR><TD  BGCOLOR="#000000" BACKGROUND="/inc/img/black_banner.jpg"><A HREF=""><IMG  SRC="/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR>
</TABLE>

<!-- main table -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0 height=100%>
 <TR>
	<TD WIDTH=16><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD>
	<TD WIDTH=140   BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG  SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">

		<!------ Begin Box ------>
		<TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0  cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black>
		<FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td  colspan=2 bgcolor=#FFFFFF>
		<TABLE cellspacing=0 cellpadding=1 border=0>
			<tr><td ALIGN=middle><a  class='linkbox' href="/news/" TITLE="Rubrique news"><img width=13 height=15  hspace=5 border=0 src=/inc/img/picto-news.gif ALT=#></A></td><td><a  class='linkbox' href="/news/" TITLE="News">News</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/mail/" TITLE="Rubrique mail"><img width=15 height=11  hspace=5 border=0 src=/inc/img/picto-mail.gif ALT=#></A></td><td><a  class='linkbox' href="/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/docs/" TITLE="Rubrique docs"><img width=14 height=16  hspace=5 border=0 src=/inc/img/picto-docs.gif ALT=#></A></td><td><a  class='linkbox' href="/docs/" TITLE="Documentation">Documentation</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/cvs/" TITLE="Rubrique cvs"><img width=13 height=17  hspace=5 border=0 src=/inc/img/picto-cvs.gif ALT=#></A></td><td><a  class='linkbox' href="/cvs/" TITLE="CVS Web">CVS</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/bugs/" TITLE="Rubrique bugs"><img width=20 height=16  hspace=5 border=0 src=/inc/img/picto-bugs.gif ALT=#></A></td><td><a  class='linkbox' href="/bugs/" TITLE="Bugtracking">Bugs</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/GPL.php3" TITLE="Rubrique license"><img  width=18 height=12   hspace=5 border=0 src=/inc/img/picto-gpl.gif ALT=#></A></td><td><a  class='linkbox' href="/GPL.php3" TITLE="License">License</a></td></tr>
		</TABLE>
		</TD></TR></TABLE></TD></TR></TABLE>
		<!------ End Box  ------>

	</TD>
	<TD WIDTH=15><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
	<TD ALIGN=left valign=top><IMG  SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">

<!-- title -->
<TABLE  background="/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0  BORDER=0 width=100%><tr><td>
<A HREF="/docs/"><img src="/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A>
</td><td><IMG  SRC="/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT="">
</td></tr></table>
&nbsp;

<!-- block -->
<TABLE  bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0  BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="/inc/img/reddots.gif"></TD>
	<TD><B>Documentation</B></TD>
	<TD ALIGN=RIGHT>&nbsp;</td>
</tr></table>
<!-- Generated by Doxygen 1.2.14 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <a class="qindexRef" doxygen="_cgi:/cgi-bin/nel-search.cgi" href="/cgi-bin/nel-search.cgi">Search</a> &nbsp; </center>
<hr><h1>sound_driver_al.h</h1><a href="sound__driver__al_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 
00007 <font class="comment">/* Copyright, 2001 Nevrax Ltd.</font>
00008 <font class="comment"> *</font>
00009 <font class="comment"> * This file is part of NEVRAX NEL.</font>
00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font>
00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font>
00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font>
00013 <font class="comment"> * any later version.</font>
00014 <font class="comment"></font>
00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font>
00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font>
00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font>
00018 <font class="comment"> * General Public License for more details.</font>
00019 <font class="comment"></font>
00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font>
00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font>
00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font>
00023 <font class="comment"> * MA 02111-1307, USA.</font>
00024 <font class="comment"> */</font>
00025 
00026 <font class="preprocessor">#ifndef NL_SOUND_DRIVER_AL_H</font>
00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_SOUND_DRIVER_AL_H</font>
00028 <font class="preprocessor"></font>
00029 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font>
00030 <font class="preprocessor">#include "<a class="code" href="sound__driver_8h.html">sound/driver/sound_driver.h</a>"</font>
00031 <font class="preprocessor">#include "<a class="code" href="source__al_8h.html">sound/driver/openal/source_al.h</a>"</font>
00032 <font class="preprocessor">#include "<a class="code" href="buffer__al_8h.html">sound/driver/openal/buffer_al.h</a>"</font>
00033 <font class="preprocessor">#include &lt;AL/al.h&gt;</font>
00034 <font class="preprocessor">#ifdef NL_OS_WINDOWS</font>
00035 <font class="preprocessor"></font><font class="preprocessor">#include &lt;objbase.h&gt;</font> <font class="comment">// needed before eax.h</font>
00036 <font class="preprocessor">#define EAX_AVAILABLE</font>
00037 <font class="preprocessor"></font><font class="preprocessor">#endif</font>
00038 <font class="preprocessor"></font>
00039 <font class="preprocessor">#ifdef EAX_AVAILABLE</font>
00040 <font class="preprocessor"></font><font class="preprocessor">#include &lt;eax.h&gt;</font> <font class="comment">// no EAX on Linux !</font>
00041 <font class="preprocessor">#endif</font>
00042 <font class="preprocessor"></font>
00043 <font class="preprocessor">#include &lt;vector&gt;</font>
00044 
00045 
00046 <font class="keyword">namespace </font>NLSOUND {
00047 
00048 
00049 <font class="comment">// alGenBuffers, alGenSources</font>
00050 <font class="comment">//typedef ALAPI ALvoid ALAPIENTRY (*TGenFunctionAL) ( ALsizei, ALuint* );</font>
00051 <font class="keyword">typedef</font> ALvoid (*<a class="code" href="namespaceNLSOUND.html#a36">TGenFunctionAL</a>) ( ALsizei, ALuint* );
00052 
00053 <font class="comment">// alIsBuffer, alIsSource</font>
00054 <font class="comment">//typedef ALAPI ALboolean ALAPIENTRY (*TTestFunctionAL) ( ALuint );</font>
00055 <font class="keyword">typedef</font> ALboolean (*<a class="code" href="namespaceNLSOUND.html#a37">TTestFunctionAL</a>) ( ALuint );
00056 
00057 
00058 <font class="preprocessor">#ifdef EAX_AVAILABLE</font>
00059 <font class="preprocessor"></font><font class="comment">// EAXSet global function</font>
00060 <font class="keyword">extern</font> EAXSet   EAXSetProp;
00061 
00062 <font class="comment">// EAXGet global function</font>
00063 <font class="keyword">extern</font> EAXGet   EAXGetProp;
00064 <font class="preprocessor">#endif</font>
00065 <font class="preprocessor"></font>
00066 
00067 <font class="preprocessor">#ifdef NL_DEBUG</font>
00068 <font class="preprocessor"></font><font class="keywordtype">void</font> <a class="code" href="sound__driver__al_8h.html#a0">TestALError</a>();
00069 <font class="preprocessor">#else</font>
<a name="l00070"></a><a class="code" href="sound__driver__al_8h.html#a0">00070</a> <font class="preprocessor"></font><font class="preprocessor">#define TestALError() </font>
00071 <font class="preprocessor"></font><font class="preprocessor">#endif</font>
00072 <font class="preprocessor"></font>
00073 
00074 
<a name="l00087"></a><a class="code" href="classNLSOUND_1_1CSoundDriverAL.html">00087</a> <font class="keyword">class </font>CSoundDriverAL : <font class="keyword">public</font> ISoundDriver
00088 {
00089 <font class="keyword">public</font>:
00090 
00092         <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a0">CSoundDriverAL</a>();
00093 
<a name="l00095"></a><a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#d0">00095</a>         <font class="keyword">static</font> <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a0">CSoundDriverAL</a>   *<a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#d0">instance</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#r0">_Instance</a>; }
00096 
00098         <font class="keyword">virtual</font> <font class="keywordtype">bool</font>                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a1">init</a>();
00099 
00101         <font class="keyword">virtual</font> IBuffer                 *<a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a2">createBuffer</a>();
00102 
00104         <font class="keyword">virtual</font> IListener               *<a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a3">createListener</a>();
00105 
<a name="l00107"></a><a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a4">00107</a>         <font class="keyword">virtual</font> uint                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a4">countMaxSources</a>()       { <font class="keywordflow">return</font> 32; }
00108 
00110         <font class="keyword">virtual</font> ISource                 *<a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a5">createSource</a>();
00111 
00113         <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a6">applyRolloffFactor</a>( <font class="keywordtype">float</font> f );
00114 
00116         <font class="keyword">virtual</font> <font class="keywordtype">bool</font>                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a7">loadWavFile</a>( IBuffer *destbuffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *filename );
00117 
<a name="l00119"></a><a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a8">00119</a>         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a8">commit3DChanges</a>() {}
00120 
<a name="l00122"></a><a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a9">00122</a>         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a9">writeProfile</a>(std::ostream&amp; out) {}
00123 
00124         <font class="comment">// Does not create a sound loader</font>
00125 
00126 <font class="keyword">public</font>:
00127         
00129         <font class="keyword">virtual</font>                                 <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a10">~CSoundDriverAL</a>();
00130 
00131 <font class="keyword">protected</font>:
00132 
00133         <font class="keyword">friend</font> <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#b0">CBufferAL::~CBufferAL</a>();
00134         <font class="keyword">friend</font> <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#b1">CSourceAL::~CSourceAL</a>();
00135 
00137         <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#b2">removeBuffer</a>( IBuffer *buffer );
00138 
00140         <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#b3">removeSource</a>( ISource *source );
00141 
00142 <font class="keyword">protected</font>:
00143 
00145         <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#b4">allocateNewItems</a>( <a class="code" href="namespaceNLSOUND.html#a36">TGenFunctionAL</a> algenfunc, <a class="code" href="namespaceNLSOUND.html#a37">TTestFunctionAL</a> altestfunc,
00146                                                                                           std::vector&lt;ALuint&gt;&amp; names, uint <a class="code" href="driver__opengl__extension__def_8h.html#a358">index</a>, uint nb );
00147 
00149         <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#b5">generateItems</a>( <a class="code" href="namespaceNLSOUND.html#a36">TGenFunctionAL</a> algenfunc, <a class="code" href="namespaceNLSOUND.html#a37">TTestFunctionAL</a> altestfunc, uint nb, ALuint *array );
00150 
00152         uint                                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#b6">compactAliveNames</a>( std::vector&lt;ALuint&gt;&amp; names, <a class="code" href="namespaceNLSOUND.html#a37">TTestFunctionAL</a> testfunc );
00153 
00155         ALuint                                  <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#b7">createItem</a>( <a class="code" href="namespaceNLSOUND.html#a36">TGenFunctionAL</a> algenfunc, <a class="code" href="namespaceNLSOUND.html#a37">TTestFunctionAL</a> altestfunc,
00156                                                                                 std::vector&lt;ALuint&gt;&amp; names, uint&amp; <a class="code" href="driver__opengl__extension__def_8h.html#a358">index</a>, uint allocrate );
00157 
00159         <font class="keywordtype">bool</font>                                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#b8">deleteItem</a>( ALuint name, <a class="code" href="namespaceNLSOUND.html#a36">TGenFunctionAL</a> aldeletefunc, std::vector&lt;ALuint&gt;&amp; names );
00160         
00161 <font class="keyword">private</font>:
00162 
00163         <font class="comment">// The instance of the singleton</font>
00164         <font class="keyword">static</font> <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#a0">CSoundDriverAL</a>   *<a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#r0">_Instance</a>;
00165 
00166         <font class="comment">// Allocated buffers</font>
<a name="l00167"></a><a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#o0">00167</a>         std::vector&lt;ALuint&gt;             <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#o0">_Buffers</a>;
00168 
00169         <font class="comment">// Allocated sources</font>
<a name="l00170"></a><a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#o1">00170</a>         std::vector&lt;ALuint&gt;             <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#o1">_Sources</a>;
00171 
00172         <font class="comment">// Number of exported buffers (including any deleted buffers)</font>
<a name="l00173"></a><a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#o2">00173</a>         uint                                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#o2">_NbExpBuffers</a>;
00174 
00175         <font class="comment">// Number of exported sources (including any deleted buffers)</font>
<a name="l00176"></a><a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#o3">00176</a>         uint                                    <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#o3">_NbExpSources</a>;
00177 
00178         <font class="comment">// Rolloff factor (not in the listener in OpenAL, but relative to the sources)</font>
<a name="l00179"></a><a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#o4">00179</a>         <font class="keywordtype">float</font>                                   <a class="code" href="classNLSOUND_1_1CSoundDriverAL.html#o4">_RolloffFactor</a>;
00180 
00181 };
00182 
00183 
00184 } <font class="comment">// NLSOUND</font>
00185 
00186 
00187 <font class="preprocessor">#endif // NL_SOUND_DRIVER_AL_H</font>
00188 <font class="preprocessor"></font>
00189 <font class="comment">/* End of sound_driver_al.h */</font>
</pre></div>

<!-- footer -->
<BR><FONT Size=+5>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </FONT>
</TD>
<TD WIDTH=15><IMG  SRC=/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
</TR>
</TABLE>
</BODY>
</HTML>