X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=simgear%2Fsound%2Fsoundmgr_openal.hxx;h=58168fc8822f44e5b1aca32bd82720b7efad17d7;hb=105438fc581a9b1d65a9309f6e845f9558f3a505;hp=676d6d53841a5d1a7c7dd7212effcf7e28894bf5;hpb=5ac2abe3abe399858e7a8c7288ce71338daf20bf;p=simgear.git diff --git a/simgear/sound/soundmgr_openal.hxx b/simgear/sound/soundmgr_openal.hxx index 676d6d53..58168fc8 100644 --- a/simgear/sound/soundmgr_openal.hxx +++ b/simgear/sound/soundmgr_openal.hxx @@ -1,4 +1,8 @@ -// 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 // 2001 @@ -9,81 +13,35 @@ // Copyright (C) 2001 Curtis L. Olson - http://www.flightgear.org/~curt // Copyright (C) 2009 Erik Hofman // -// 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 #include #include - -#if defined(__APPLE__) -# define AL_ILLEGAL_ENUM AL_INVALID_ENUM -# define AL_ILLEGAL_COMMAND AL_INVALID_OPERATION -# include -# include -# include -#elif defined(OPENALSDK) -# include -# include -# include -#else -# include -# include -# include -#endif - +#include // for std::auto_ptr + #include #include -#include - -#include "sample_group.hxx" -#include "sample_openal.hxx" - -using std::string; +#include -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 > 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 @@ -96,21 +54,25 @@ public: ~SGSoundMgr(); void init(); - void bind(); - void unbind(); 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. @@ -125,119 +87,132 @@ public: /** * 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 Geodetic position of the sound manager. + * Set the Cartesian position of the sound manager. + * * @param pos OpenAL listener position */ - void set_position_geod( const SGGeod& pos ) { - _absolute_pos = SGVec3d::fromGeod( pos ); _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 SGVec3f& vel ) { + 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 _velocity; } + 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. */ @@ -245,6 +220,7 @@ public: /** * 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 ); @@ -252,12 +228,22 @@ public: /** * 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 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. + */ + inline bool bad_doppler_effect() { return _bad_doppler; } + /** * 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 @@ -265,45 +251,48 @@ public: * @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 ); -private: - static int _alut_init; + /** + * Get a list of available playback devices. + */ + std::vector get_available_devices(); - bool _working; + /** + * Get the current OpenAL vendor or rendering backend. + */ + const std::string& get_vendor() { return _vendor; } + const std::string& get_renderer() { return _renderer; } + +private: + class SoundManagerPrivate; + /// private implementation object + std::auto_ptr d; + bool _active; bool _changed; float _volume; - ALCdevice *_device; - ALCcontext *_context; - // Position of the listener. - SGVec3d _absolute_pos; + SGVec3d _offset_pos; + SGGeod _geod_pos; // Velocity of the listener. - SGVec3f _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 _free_sources; - vector _sources_in_use; + SGVec3d _velocity; - char *_devname; + 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 ); };