]> git.mxchange.org Git - simgear.git/blob - simgear/sound/sample_group.cxx
get rid of aut_ptr, it only works with objects that can destroyed with delete (and...
[simgear.git] / simgear / sound / sample_group.cxx
1 // sample_group.cxx -- Manage a group of samples relative to a base position
2 //
3 // Written for the new SoundSystem by Erik Hofman, October 2009
4 //
5 // Copyright (C) 2009 Erik Hofman <erik@ehofman.com>
6 //
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
11 //
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 // General Public License for more details.
16 //
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software Foundation,
19 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
20 //
21 // $Id$
22
23 #ifdef HAVE_CONFIG_H
24 #  include <simgear_config.h>
25 #endif
26
27 #include <simgear/compiler.h>
28
29 #if defined (__APPLE__)
30 #  ifdef __GNUC__
31 #    if ( __GNUC__ >= 3 ) && ( __GNUC_MINOR__ >= 3 )
32 //  #        include <math.h>
33 inline int (isnan)(double r) { return !(r <= 0 || r >= 0); }
34 #    else
35     // any C++ header file undefines isinf and isnan
36     // so this should be included before <iostream>
37     // the functions are STILL in libm (libSystem on mac os x)
38 extern "C" int isnan (double);
39 extern "C" int isinf (double);
40 #    endif
41 #  else
42 //    inline int (isinf)(double r) { return isinf(r); }
43 //    inline int (isnan)(double r) { return isnan(r); }
44 #  endif
45 #endif
46
47 #if defined (__FreeBSD__)
48 #  if __FreeBSD_version < 500000
49      extern "C" {
50        inline int isnan(double r) { return !(r <= 0 || r >= 0); }
51      }
52 #  endif
53 #endif
54
55 #if defined (__CYGWIN__)
56 #  include <ieeefp.h>
57 #endif
58
59 #if defined(__MINGW32__)
60 #  define isnan(x) _isnan(x)
61 #endif
62
63 #include "soundmgr_openal.hxx"
64 #include "sample_group.hxx"
65
66 SGSampleGroup::SGSampleGroup () :
67     _smgr(NULL),
68     _refname(""),
69     _active(false),
70     _pause(false),
71     _tied_to_listener(false),
72     _velocity(SGVec3d::zeros()),
73     _orientation(SGQuatd::zeros()),
74     _position(SGGeod())
75 {
76     _samples.clear();
77 }
78
79 SGSampleGroup::SGSampleGroup ( SGSoundMgr *smgr, const string &refname ) :
80     _smgr(smgr),
81     _refname(refname),
82     _active(false), 
83     _pause(false),
84     _tied_to_listener(false),
85     _velocity(SGVec3d::zeros()),
86     _orientation(SGQuatd::zeros()),
87     _position(SGGeod())
88 {
89     _smgr->add(this, refname);
90     _samples.clear();
91 }
92
93 SGSampleGroup::~SGSampleGroup ()
94 {
95     _active = false;
96
97     sample_map_iterator sample_current = _samples.begin();
98     sample_map_iterator sample_end = _samples.end();
99     for ( ; sample_current != sample_end; ++sample_current ) {
100         SGSoundSample *sample = sample_current->second;
101
102         if ( sample->is_valid_source() && sample->is_playing() ) {
103             sample->no_valid_source();
104             _smgr->release_source( sample->get_source() );
105             _smgr->release_buffer( sample );
106         }
107     }
108
109     _smgr = 0;
110 }
111
112 void SGSampleGroup::update( double dt ) {
113
114     if ( !_active || _pause ) return;
115
116     testForALError("start of update!!\n");
117
118     // Delete any OpenAL buffers that might still be in use.
119     unsigned int size = _removed_samples.size();
120     for (unsigned int i=0; i<size; ) {
121         SGSoundSample *sample = _removed_samples[i];
122         ALint result;
123
124         alGetSourcei( sample->get_source(), AL_SOURCE_STATE, &result );
125         if ( result == AL_STOPPED ) {
126             ALuint buffer = sample->get_buffer();
127             alDeleteBuffers( 1, &buffer );
128             testForALError("buffer remove");
129             _removed_samples.erase( _removed_samples.begin()+i );
130             size--;
131             continue;
132         }
133         i++;
134     }
135
136     sample_map_iterator sample_current = _samples.begin();
137     sample_map_iterator sample_end = _samples.end();
138     for ( ; sample_current != sample_end; ++sample_current ) {
139         SGSoundSample *sample = sample_current->second;
140
141         if ( !sample->is_valid_source() && sample->is_playing() ) {
142             //
143             // a request to start playing a sound has been filed.
144             //
145             if ( _smgr->request_buffer(sample) == SGSoundMgr::NO_BUFFER )
146                 continue;
147
148             // start playing the sample
149             ALuint buffer = sample->get_buffer();
150             ALuint source = _smgr->request_source();
151             if (alIsSource(source) == AL_TRUE && alIsBuffer(buffer) == AL_TRUE)
152             {
153                 sample->set_source( source );
154                 
155                 alSourcei( source, AL_BUFFER, buffer );
156                 testForALError("assign buffer to source");
157
158                 sample->set_source( source );
159                 update_sample_config( sample );
160
161                 ALboolean looping = sample->get_looping() ? AL_TRUE : AL_FALSE;
162                 alSourcei( source, AL_LOOPING, looping );
163                 alSourcef( source, AL_ROLLOFF_FACTOR, 1.0 );
164                 alSourcei( source, AL_SOURCE_RELATIVE, AL_FALSE );
165                 alSourcePlay( source );
166                 testForALError("sample play");
167             } else {
168                 if (alIsBuffer(buffer) == AL_FALSE) 
169                    SG_LOG( SG_GENERAL, SG_ALERT, "No such buffer!\n");
170                 // sample->no_valid_source();
171                 // sadly, no free source available at this time
172             }
173
174         } else if ( sample->is_valid_source() && sample->has_changed() ) {
175             if ( !sample->is_playing() ) {
176                 // a request to stop playing the sound has been filed.
177
178                 sample->stop();
179                 sample->no_valid_source();
180                 _smgr->release_source( sample->get_source() );
181             } else  {
182                 update_sample_config( sample );
183             }
184
185         } else if ( sample->is_valid_source() ) {
186             // check if the sound has stopped by itself
187
188             unsigned int source = sample->get_source();
189             int result;
190
191             alGetSourcei( source, AL_SOURCE_STATE, &result );
192             if ( result == AL_STOPPED ) {
193                 // sample is stoped because it wasn't looping
194                 sample->stop();
195                 sample->no_valid_source();
196                 _smgr->release_source( source );
197                 _smgr->release_buffer( sample );
198             }
199         }
200         testForALError("update");
201     }
202 }
203
204 // add a sound effect, return true if successful
205 bool SGSampleGroup::add( SGSoundSample *sound, const string& refname ) {
206
207     sample_map_iterator sample_it = _samples.find( refname );
208     if ( sample_it != _samples.end() ) {
209         // sample name already exists
210         return false;
211     }
212
213     _samples[refname] = sound;
214     return true;
215 }
216
217
218 // remove a sound effect, return true if successful
219 bool SGSampleGroup::remove( const string &refname ) {
220
221     sample_map_iterator sample_it = _samples.find( refname );
222     if ( sample_it == _samples.end() ) {
223         // sample was not found
224         return false;
225     }
226
227     if ( sample_it->second->is_valid_buffer() )
228         _removed_samples.push_back( sample_it->second );
229     _samples.erase( sample_it );
230
231     return true;
232 }
233
234
235 // return true of the specified sound exists in the sound manager system
236 bool SGSampleGroup::exists( const string &refname ) {
237     sample_map_iterator sample_it = _samples.find( refname );
238     if ( sample_it == _samples.end() ) {
239         // sample was not found
240         return false;
241     }
242
243     return true;
244 }
245
246
247 // return a pointer to the SGSoundSample if the specified sound exists
248 // in the sound manager system, otherwise return NULL
249 SGSoundSample *SGSampleGroup::find( const string &refname ) {
250     sample_map_iterator sample_it = _samples.find( refname );
251     if ( sample_it == _samples.end() ) {
252         // sample was not found
253         return NULL;
254     }
255
256     return sample_it->second;
257 }
258
259
260 // stop playing all associated samples
261 void
262 SGSampleGroup::suspend ()
263 {
264     _pause = true;
265     sample_map_iterator sample_current = _samples.begin();
266     sample_map_iterator sample_end = _samples.end();
267     for ( ; sample_current != sample_end; ++sample_current ) {
268         SGSoundSample *sample = sample_current->second;
269
270         if ( sample->is_valid_source() && sample->is_playing() ) {
271             alSourcePause( sample->get_source() );
272         }
273     }
274     testForALError("suspend");
275 }
276
277 // resume playing all associated samples
278 void
279 SGSampleGroup::resume ()
280 {
281     sample_map_iterator sample_current = _samples.begin();
282     sample_map_iterator sample_end = _samples.end();
283     for ( ; sample_current != sample_end; ++sample_current ) {
284         SGSoundSample *sample = sample_current->second;
285
286         if ( sample->is_valid_source() && sample->is_playing() ) {
287             alSourcePlay( sample->get_source() );
288         }
289     }
290     testForALError("resume");
291     _pause = false;
292 }
293
294
295 // tell the scheduler to play the indexed sample in a continuous loop
296 bool SGSampleGroup::play( const string &refname, bool looping = false ) {
297     SGSoundSample *sample = find( refname );
298
299     if ( sample == NULL ) {
300         return false;
301     }
302
303     sample->play( looping );
304     return true;
305 }
306
307
308 // return true of the specified sound is currently being played
309 bool SGSampleGroup::is_playing( const string& refname ) {
310     SGSoundSample *sample = find( refname );
311
312     if ( sample == NULL ) {
313         return false;
314     }
315
316     return ( sample->is_playing() ) ? true : false;
317 }
318
319 // immediate stop playing the sound
320 bool SGSampleGroup::stop( const string& refname ) {
321     SGSoundSample *sample  = find( refname );
322
323     if ( sample == NULL ) {
324         return false;
325     }
326
327     sample->stop();
328     return true;
329 }
330
331 // set source velocity of all managed sounds
332 void SGSampleGroup::set_velocity( const SGVec3d &vel ) {
333     if ( isnan(vel[0]) || isnan(vel[1]) || isnan(vel[2]) )
334     {
335         SG_LOG( SG_GENERAL, SG_ALERT, "NAN's found in SampleGroup velocity");
336         return;
337     }
338
339     if (_velocity != vel) {
340         sample_map_iterator sample_current = _samples.begin();
341         sample_map_iterator sample_end = _samples.end();
342         for ( ; sample_current != sample_end; ++sample_current ) {
343             SGSoundSample *sample = sample_current->second;
344             sample->set_velocity( vel );
345         }
346         _velocity = vel;
347     }
348 }
349
350 // set the source position of all managed sounds
351 void SGSampleGroup::set_position( const SGGeod& pos ) {
352
353     sample_map_iterator sample_current = _samples.begin();
354     sample_map_iterator sample_end = _samples.end();
355     for ( ; sample_current != sample_end; ++sample_current ) {
356         SGSoundSample *sample = sample_current->second;
357         sample->set_position( pos );
358     }
359     _position = pos;
360 }
361
362
363 // set the source orientation of all managed sounds
364 void SGSampleGroup::set_orientation( const SGQuatd& ori ) {
365
366     if (_orientation != ori) {
367         sample_map_iterator sample_current = _samples.begin();
368         sample_map_iterator sample_end = _samples.end();
369         for ( ; sample_current != sample_end; ++sample_current ) {
370             SGSoundSample *sample = sample_current->second;
371             sample->set_orientation( ori );
372         }
373         _orientation = ori;
374     }
375 }
376
377 void SGSampleGroup::set_volume( float vol )
378 {
379     _volume = vol;
380     if (_volume < 0.0) _volume = 0.0;
381     if (_volume > 1.0) _volume = 1.0;
382
383     sample_map_iterator sample_current = _samples.begin();
384     sample_map_iterator sample_end = _samples.end();
385     for ( ; sample_current != sample_end; ++sample_current ) {
386         SGSoundSample *sample = sample_current->second;
387         sample->set_master_volume( _volume );
388     }
389 }
390
391 void SGSampleGroup::update_sample_config( SGSoundSample *sample ) {
392     if ( sample->is_valid_source() ) {
393         unsigned int source = sample->get_source();
394
395 #if 0
396         if ( _tied_to_listener && _smgr->has_changed() ) {
397             alSourcefv( source, AL_POSITION, _smgr->get_position().data() );
398             alSourcefv( source, AL_DIRECTION, _smgr->get_direction().data() );
399             alSourcefv( source, AL_VELOCITY, _smgr->get_velocity().data() );
400         } else {
401             alSourcefv( source, AL_POSITION, sample->get_position() );
402             alSourcefv( source, AL_DIRECTION, sample->get_orientation() );
403             alSourcefv( source, AL_VELOCITY, sample->get_velocity() );
404         }
405 #else
406         alSourcefv( source, AL_POSITION, SGVec3f::zeros().data() );
407         alSourcefv( source, AL_DIRECTION, SGVec3f::zeros().data() );
408         alSourcefv( source, AL_VELOCITY, SGVec3f::zeros().data() );
409 #endif
410         testForALError("position and orientation");
411
412         alSourcef( source, AL_PITCH, sample->get_pitch() );
413         alSourcef( source, AL_GAIN, sample->get_volume() );
414         testForALError("pitch and gain");
415
416         if ( sample->has_static_data_changed() ) {
417 #if 0
418             alSourcef( source, AL_CONE_INNER_ANGLE, sample->get_innerangle() );
419             alSourcef( source, AL_CONE_OUTER_ANGLE, sample->get_outerangle() );
420             alSourcef( source, AL_CONE_OUTER_GAIN, sample->get_outergain() );
421 #endif
422             testForALError("audio cone");
423
424             alSourcef( source, AL_MAX_DISTANCE, sample->get_max_dist() );
425             alSourcef( source, AL_REFERENCE_DISTANCE,
426                                sample->get_reference_dist() );
427             testForALError("distance rolloff");
428         }
429     }
430 }
431
432 bool SGSampleGroup::testForError(void *p, string s)
433 {
434    if (p == NULL) {
435       SG_LOG( SG_GENERAL, SG_ALERT, "Error (sample group): " << s);
436       return true;
437    }
438    return false;
439 }
440
441 bool SGSampleGroup::testForALError(string s)
442 {
443     ALenum error = alGetError();
444     if (error != AL_NO_ERROR)  {
445        SG_LOG( SG_GENERAL, SG_ALERT, "AL Error (" << _refname << "): "
446                                       << alGetString(error) << " at " << s);
447        return true;
448     }
449     return false;
450 }
451