-// soundmgr.hxx -- Sound effect management class
+///@file
+/// Sound effect management class
+///
+/// Provides a sound manager class to keep track of multiple sounds and manage
+/// playing them with different effects and timings.
//
// Sound manager initially written by David Findlay
// <david_j_findlay@yahoo.com.au> 2001
// Copyright (C) 2001 Curtis L. Olson - http://www.flightgear.org/~curt
// Copyright (C) 2009 Erik Hofman <erik@ehofman.com>
//
-// This program is free software; you can redistribute it and/or
-// modify it under the terms of the GNU General Public License as
-// published by the Free Software Foundation; either version 2 of the
-// License, or (at your option) any later version.
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
//
-// This program is distributed in the hope that it will be useful, but
-// WITHOUT ANY WARRANTY; without even the implied warranty of
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-// General Public License for more details.
+// Library General Public License for more details.
//
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the Free Software Foundation,
-// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-//
-// $Id$
-
-/**
- * \file soundmgr.hxx
- * Provides a sound manager class to keep track of
- * multiple sounds and manage playing them with different effects and
- * timings.
- */
+// You should have received a copy of the GNU Library General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
#ifndef _SG_SOUNDMGR_OPENAL_HXX
#define _SG_SOUNDMGR_OPENAL_HXX 1
-#ifndef __cplusplus
-# error This library requires C++
-#endif
-
#include <string>
#include <vector>
#include <map>
-
-#if defined(__APPLE__)
-# define AL_ILLEGAL_ENUM AL_INVALID_ENUM
-# define AL_ILLEGAL_COMMAND AL_INVALID_OPERATION
-# include <OpenAL/al.h>
-# include <OpenAL/alc.h>
-# include <OpenAL/alut.h>
-#elif defined(OPENALSDK)
-# include <al.h>
-# include <alc.h>
-# include <AL/alut.h>
-#else
-# include <AL/al.h>
-# include <AL/alc.h>
-# include <AL/alut.h>
-#endif
-
-#ifndef ALC_ALL_DEVICES_SPECIFIER
-# define ALC_ALL_DEVICES_SPECIFIER 0x1013
-#endif
-
+#include <memory> // for std::auto_ptr
+
#include <simgear/compiler.h>
#include <simgear/structure/subsystem_mgr.hxx>
-#include <simgear/math/SGMathFwd.hxx>
+#include <simgear/math/SGMath.hxx>
-#include "sample_group.hxx"
-#include "sample_openal.hxx"
-
-using std::string;
-
-struct refUint {
- unsigned int refctr;
- ALuint id;
-
- refUint() { refctr = 0; id = (ALuint)-1; };
- refUint(ALuint i) { refctr = 1; id = i; };
- ~refUint() {};
-};
-
-typedef std::map < string, refUint > buffer_map;
-typedef buffer_map::iterator buffer_map_iterator;
-typedef buffer_map::const_iterator const_buffer_map_iterator;
-
-typedef std::map < string, SGSharedPtr<SGSampleGroup> > sample_group_map;
-typedef sample_group_map::iterator sample_group_map_iterator;
-typedef sample_group_map::const_iterator const_sample_group_map_iterator;
+// forward decls
+class SGSampleGroup;
+class SGSoundSample;
/**
* Manage a collection of SGSampleGroup instances
SGSoundMgr();
~SGSoundMgr();
- void init(const char *devname = NULL);
- void bind();
- void unbind();
+ void init();
void update(double dt);
void suspend();
void resume();
void stop();
- inline void reinit() { stop(); init(); }
+ void reinit();
+
+ /**
+ * Select a specific sound device.
+ * Requires a init/reinit call before sound is actually switched.
+ */
+ inline void select_device(const char* devname) {_device_name = devname;}
/**
* Test is the sound manager is in a working condition.
* @return true is the sound manager is working
*/
- inline bool is_working() const { return _working; }
+ bool is_working() const;
/**
* Set the sound manager to a working condition.
/**
* Register a sample group to the sound manager.
- * @para sgrp Pointer to a sample group to add
+ * @param sgrp Pointer to a sample group to add
* @param refname Reference name of the sample group
* @return true if successful, false otherwise
*/
- bool add( SGSampleGroup *sgrp, const string& refname );
+ bool add( SGSampleGroup *sgrp, const std::string& refname );
/**
* Remove a sample group from the sound manager.
* @param refname Reference name of the sample group to remove
* @return true if successful, false otherwise
*/
- bool remove( const string& refname );
+ bool remove( const std::string& refname );
/**
* Test if a specified sample group is registered at the sound manager
* @param refname Reference name of the sample group test for
* @return true if the specified sample group exists
*/
- bool exists( const string& refname );
+ bool exists( const std::string& refname );
/**
* Find a specified sample group in the sound manager
+ *
* @param refname Reference name of the sample group to find
+ * @param create If the group should be create if it does not exist
* @return A pointer to the SGSampleGroup
*/
- SGSampleGroup *find( const string& refname, bool create = false );
+ SGSampleGroup *find( const std::string& refname, bool create = false );
/**
* Set the Cartesian position of the sound manager.
+ *
* @param pos OpenAL listener position
*/
- void set_position( const SGVec3d& pos, const SGGeod& pos_geod ) {
- _base_pos = pos; _geod_pos = pos_geod; _changed = true;
- }
+ void set_position( const SGVec3d& pos, const SGGeod& pos_geod );
void set_position_offset( const SGVec3d& pos ) {
_offset_pos = pos; _changed = true;
/**
* Get the position of the sound manager.
* This is in the same coordinate system as OpenGL; y=up, z=back, x=right
+ *
* @return OpenAL listener position
*/
- SGVec3d& get_position() { return _absolute_pos; }
+ const SGVec3d& get_position() const;
/**
* Set the velocity vector (in meters per second) of the sound manager
* This is the horizontal local frame; x=north, y=east, z=down
- * @param Velocity vector
+ *
+ * @param vel Velocity vector
*/
void set_velocity( const SGVec3d& vel ) {
_velocity = vel; _changed = true;
/**
* Get the velocity vector of the sound manager
* This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
+ *
* @return Velocity vector of the OpenAL listener
*/
inline SGVec3f get_velocity() { return toVec3f(_velocity); }
/**
* Set the orientation of the sound manager
+ *
* @param ori Quaternation containing the orientation information
*/
- void set_orientation( const SGQuatd& ori ) {
- _orientation = ori; _changed = true;
- }
+ void set_orientation( const SGQuatd& ori );
/**
* Get the orientation of the sound manager
+ *
* @return Quaternation containing the orientation information
*/
- inline const SGQuatd& get_orientation() { return _orientation; }
+ const SGQuatd& get_orientation() const;
/**
* Get the direction vector of the sound manager
* This is in the same coordinate system as OpenGL; y=up, z=back, x=right.
+ *
* @return Look-at direction of the OpenAL listener
*/
- SGVec3f get_direction() {
- return SGVec3f(_at_up_vec[0], _at_up_vec[1], _at_up_vec[2]);
- }
+ SGVec3f get_direction() const;
enum {
NO_SOURCE = (unsigned int)-1,
- NO_BUFFER = (unsigned int)-1
+ NO_BUFFER = (unsigned int)-1,
+ FAILED_BUFFER = (unsigned int)-2
};
/**
* Set the master volume.
+ *
* @param vol Volume (must be between 0.0 and 1.0)
*/
void set_volume( float vol );
/**
* Get the master volume.
+ *
* @return Volume (must be between 0.0 and 1.0)
*/
inline float get_volume() { return _volume; }
/**
* Get a free OpenAL source-id
+ *
* @return NO_SOURCE if no source is available
*/
unsigned int request_source();
/**
* Free an OpenAL source-id for future use
+ *
* @param source OpenAL source-id to free
*/
void release_source( unsigned int source );
/**
* Get a free OpenAL buffer-id
- * The buffer-id will be asigned to the sample by calling this function.
+ * The buffer-id will be assigned to the sample by calling this function.
+ *
* @param sample Pointer to an audio sample to assign the buffer-id to
* @return NO_BUFFER if loading of the buffer failed.
*/
/**
* Free an OpenAL buffer-id for this sample
+ *
* @param sample Pointer to an audio sample for which to free the buffer
*/
void release_buffer( SGSoundSample *sample );
/**
* Test if the position of the sound manager has changed.
* The value will be set to false upon the next call to update_late()
+ *
* @return true if the position has changed
*/
inline bool has_changed() { return _changed; }
/**
- * Some implementations seem to need the velocity miltyplied by a
+ * Some implementations seem to need the velocity multiplied by a
* factor of 100 to make them distinct. I've not found if this is
* a problem in the implementation or in out code. Until then
* this function is used to detect the problematic implementations.
/**
* Load a sample file and return it's configuration and data.
+ *
* @param samplepath Path to the file to load
* @param data Pointer to a variable that points to the allocated data
* @param format Pointer to a vairable that gets the OpenAL format
* @param freq Pointer to a vairable that gets the sample frequency in Herz
* @return true if succesful, false on error
*/
- bool load(string &samplepath, void **data, int *format,
- size_t *size, int *freq );
+ bool load( const std::string &samplepath,
+ void **data,
+ int *format,
+ size_t *size,
+ int *freq );
/**
* Get a list of available playback devices.
*/
- vector<const char*> get_available_devices();
+ std::vector<const char*> get_available_devices();
-private:
- static int _alut_init;
+ /**
+ * Get the current OpenAL vendor or rendering backend.
+ */
+ const std::string& get_vendor() { return _vendor; }
+ const std::string& get_renderer() { return _renderer; }
- bool _working;
+private:
+ class SoundManagerPrivate;
+ /// private implementation object
+ std::auto_ptr<SoundManagerPrivate> d;
+
bool _active;
bool _changed;
float _volume;
- ALCdevice *_device;
- ALCcontext *_context;
-
// Position of the listener.
- SGVec3d _absolute_pos;
SGVec3d _offset_pos;
- SGVec3d _base_pos;
SGGeod _geod_pos;
// Velocity of the listener.
SGVec3d _velocity;
- // Orientation of the listener.
- // first 3 elements are "at" vector, second 3 are "up" vector
- SGQuatd _orientation;
- ALfloat _at_up_vec[6];
-
- sample_group_map _sample_groups;
- buffer_map _buffers;
-
- vector<ALuint> _free_sources;
- vector<ALuint> _sources_in_use;
-
bool _bad_doppler;
+ std::string _renderer;
+ std::string _vendor;
+ std::string _device_name;
- bool testForALError(string s);
- bool testForALCError(string s);
- bool testForALUTError(string s);
- bool testForError(void *p, string s);
+ bool testForALError(std::string s);
+ bool testForALCError(std::string s);
+ bool testForError(void *p, std::string s);
- void update_pos_and_orientation();
void update_sample_config( SGSampleGroup *sound );
};
projects / simgear.git / blobdiff