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
|
<!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> <A CLASS=uplinks HREF='/'><b>Home</B></FONT></A> </TD>
<TD><IMG width=6 height=14 SRC="/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF='/'><b>nevrax.com</B></FONT></A> </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>
<!-- 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> </td>
</tr></table>
<!-- Generated by Doxygen 1.2.14 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:/cgi-bin/nel-search.cgi" href="/cgi-bin/nel-search.cgi">Search</a> </center>
<hr><h1>sound.h</h1><a href="sound_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_H</font>
00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_SOUND_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="stream_8h.html">nel/misc/stream.h</a>"</font>
00031 <font class="preprocessor">#include "<a class="code" href="u__source_8h.html">nel/sound/u_source.h</a>"</font>
00032 <font class="preprocessor">#include "<a class="code" href="u__form__elm_8h.html">nel/georges/u_form_elm.h</a>"</font>
00033 <font class="preprocessor">#include <string></font>
00034 <font class="preprocessor">#include <hash_map></font>
00035
00036 <font class="keyword">namespace </font>NLSOUND {
00037
00038
00039 <font class="keyword">class </font>ISoundDriver;
00040 <font class="keyword">class </font>IBuffer;
00041 <font class="keyword">class </font>CSound;
00042
00043
00045 <font class="keyword">typedef</font> std::hash_map<std::string, CSound*> <a class="code" href="namespaceNLSOUND.html#a71">TSoundMap</a>;
00046
00048 <font class="keyword">typedef</font> std::set<CSound*> <a class="code" href="namespaceNLSOUND.html#a72">TSoundSet</a>;
00049
00050 <font class="keyword">const</font> <font class="keywordtype">double</font> <a class="code" href="namespaceNLSOUND.html#a73">Sqrt12_2</a> = 1.0594630943592952645618252949463; <font class="comment">// 2^1/12</font>
00051
<a name="l00058"></a><a class="code" href="classNLSOUND_1_1CSound.html">00058</a> <font class="keyword">class </font>CSound
00059 {
00060 <font class="keyword">public</font>:
00062 <font class="keyword">static</font> <a class="code" href="classNLSOUND_1_1CSound.html#a0">CSound</a> *<a class="code" href="classNLSOUND_1_1CSound.html#d0">createSound</a>(<font class="keyword">const</font> std::string &filename, <a class="code" href="classNLGEORGES_1_1UFormElm.html">NLGEORGES::UFormElm</a>& formRoot);
00063
<a name="l00064"></a><a class="code" href="classNLSOUND_1_1CSound.html#s4">00064</a> <font class="keyword">enum</font> <a class="code" href="classNLSOUND_1_1CSound.html#s4">TSOUND_TYPE</a>
00065 {
00066 <a class="code" href="classNLSOUND_1_1CSound.html#s4s0">SOUND_SIMPLE</a>,
00067 <a class="code" href="classNLSOUND_1_1CSound.html#s4s1">SOUND_COMPLEX</a>,
00068 <a class="code" href="classNLSOUND_1_1CSound.html#s4s2">SOUND_BACKGROUND</a>,
00069 <a class="code" href="classNLSOUND_1_1CSound.html#s4s3">SOUND_CONTEXT</a>
00070 };
00071
00072
00074 <a class="code" href="classNLSOUND_1_1CSound.html#a0">CSound</a>();
00076 <font class="keyword">virtual</font> <a class="code" href="classNLSOUND_1_1CSound.html#a1">~CSound</a>();
00077
00079 <font class="keyword">virtual</font> <a class="code" href="classNLSOUND_1_1CSound.html#s4">TSOUND_TYPE</a> <a class="code" href="classNLSOUND_1_1CSound.html#a2">getSoundType</a>() =0;
00080
00082 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSound.html#a3">importForm</a>(<font class="keyword">const</font> std::string& filename, <a class="code" href="classNLGEORGES_1_1UFormElm.html">NLGEORGES::UFormElm</a>& formRoot);
00083
<a name="l00085"></a><a class="code" href="classNLSOUND_1_1CSound.html#a4">00085</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CSound.html#a4">getLooping</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#n7">_Looping</a>; }
<a name="l00087"></a><a class="code" href="classNLSOUND_1_1CSound.html#a5">00087</a> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CSound.html#a5">getGain</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#n0">_Gain</a>; }
<a name="l00089"></a><a class="code" href="classNLSOUND_1_1CSound.html#a6">00089</a> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CSound.html#a6">getPitch</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#n1">_Pitch</a>; }
<a name="l00091"></a><a class="code" href="classNLSOUND_1_1CSound.html#a7">00091</a> <a class="code" href="namespaceNLSOUND.html#a82">TSoundPriority</a> <a class="code" href="classNLSOUND_1_1CSound.html#a7">getPriority</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#n2">_Priority</a>; }
00093 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CSound.html#a8">isDetailed</a>() <font class="keyword">const</font> = 0;
<a name="l00095"></a><a class="code" href="classNLSOUND_1_1CSound.html#a9">00095</a> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CSound.html#a9">getConeInnerAngle</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#n3">_ConeInnerAngle</a>; }
<a name="l00097"></a><a class="code" href="classNLSOUND_1_1CSound.html#a10">00097</a> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CSound.html#a10">getConeOuterAngle</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#n4">_ConeOuterAngle</a>; }
<a name="l00099"></a><a class="code" href="classNLSOUND_1_1CSound.html#a11">00099</a> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CSound.html#a11">getConeOuterGain</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#n5">_ConeOuterGain</a>; }
<a name="l00101"></a><a class="code" href="classNLSOUND_1_1CSound.html#a12">00101</a> <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &<a class="code" href="classNLSOUND_1_1CSound.html#a12">getDirectionVector</a>()<font class="keyword">const</font> { <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#n6">_Direction</a>;}
00103 <font class="keyword">virtual</font> uint32 <a class="code" href="classNLSOUND_1_1CSound.html#a13">getDuration</a>() = 0;
<a name="l00105"></a><a class="code" href="classNLSOUND_1_1CSound.html#a14">00105</a> <font class="keyword">const</font> std::string& <a class="code" href="classNLSOUND_1_1CSound.html#a14">getName</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#n9">_Name</a>; }
<a name="l00107"></a><a class="code" href="classNLSOUND_1_1CSound.html#a15">00107</a> <font class="keyword">virtual</font> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CSound.html#a15">getMaxDistance</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#n8">_MaxDist</a>; }
00108
<a name="l00110"></a><a class="code" href="classNLSOUND_1_1CSound.html#a16">00110</a> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSound.html#a16">setLooping</a>( <font class="keywordtype">bool</font> looping ) { <a class="code" href="classNLSOUND_1_1CSound.html#n7">_Looping</a> = looping; }
00111
00113 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSound.html#a17">getSubSoundList</a>(std::vector<std::pair<std::string, CSound*> > &subsounds) <font class="keyword">const</font> =0;
00114
00115
00116 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSound.html#a18">serial</a>(<a class="code" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &<a class="code" href="driver__opengl__extension__def_8h.html#a383">s</a>);
00117
<a name="l00118"></a><a class="code" href="classNLSOUND_1_1CSound.html#a19">00118</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CSound.html#a19">operator<</a>( <font class="keyword">const</font> <a class="code" href="classNLSOUND_1_1CSound.html#a0">CSound</a>& otherSound )<font class="keyword"> const</font>
00119 <font class="keyword"> </font>{
00120 <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSound.html#n9">_Name</a> < otherSound._Name;
00121 }
00122
00123 <font class="keyword">protected</font>:
00124
00125 <font class="comment">// Static properties</font>
<a name="l00126"></a><a class="code" href="classNLSOUND_1_1CSound.html#n0">00126</a> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CSound.html#n0">_Gain</a>; <font class="comment">// [0,1]</font>
<a name="l00127"></a><a class="code" href="classNLSOUND_1_1CSound.html#n1">00127</a> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CSound.html#n1">_Pitch</a>; <font class="comment">// ]0,1]</font>
<a name="l00128"></a><a class="code" href="classNLSOUND_1_1CSound.html#n2">00128</a> <a class="code" href="namespaceNLSOUND.html#a82">TSoundPriority</a> <a class="code" href="classNLSOUND_1_1CSound.html#n2">_Priority</a>;
<a name="l00129"></a><a class="code" href="classNLSOUND_1_1CSound.html#n5">00129</a> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CSound.html#n3">_ConeInnerAngle</a>, <a class="code" href="classNLSOUND_1_1CSound.html#n4">_ConeOuterAngle</a>, <a class="code" href="classNLSOUND_1_1CSound.html#n5">_ConeOuterGain</a>;
<a name="l00130"></a><a class="code" href="classNLSOUND_1_1CSound.html#n6">00130</a> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> <a class="code" href="classNLSOUND_1_1CSound.html#n6">_Direction</a>;
00131
<a name="l00132"></a><a class="code" href="classNLSOUND_1_1CSound.html#n7">00132</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CSound.html#n7">_Looping</a>;
00133
<a name="l00135"></a><a class="code" href="classNLSOUND_1_1CSound.html#n8">00135</a> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CSound.html#n8">_MaxDist</a>;
00136
00137 <font class="comment">// Sound name.</font>
<a name="l00138"></a><a class="code" href="classNLSOUND_1_1CSound.html#n9">00138</a> std::string <a class="code" href="classNLSOUND_1_1CSound.html#n9">_Name</a>;
00139
00140 };
00141
00142
<a name="l00146"></a><a class="code" href="classNLSOUND_1_1ESoundFileNotFound.html">00146</a> <font class="keyword">class </font>ESoundFileNotFound : <font class="keyword">public</font> NLMISC::Exception
00147 {
00148 <font class="keyword">public</font>:
<a name="l00149"></a><a class="code" href="classNLSOUND_1_1ESoundFileNotFound.html#a0">00149</a> <a class="code" href="classNLSOUND_1_1ESoundFileNotFound.html#a0">ESoundFileNotFound</a>( <font class="keyword">const</font> std::string filename ) :
00150 NLMISC::<a class="code" href="classNLMISC_1_1Exception.html#a0">Exception</a>( (std::string("Sound <a class="code" href="cf__lexical_8cpp.html#a95">file</a> not found, or invalid <a class="code" href="cf__lexical_8cpp.html#a95">file</a> <a class="code" href="driver__opengl__extension__def_8h.html#a398">format</a>: ")+filename).c_str() ) {}
00151 };
00152
00153
00154 } <font class="comment">// NLSOUND</font>
00155
00156
00157 <font class="preprocessor">#endif // NL_SOUND_H</font>
00158 <font class="preprocessor"></font>
00159 <font class="comment">/* End of sound.h */</font>
00160
</pre></div>
<!-- footer -->
<BR><FONT Size=+5> </FONT>
</TD>
<TD WIDTH=15><IMG SRC=/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
