/*************************************************************************** * Copyright (C) 2005-2019 by the FIFE team * * http://www.fifengine.net * * This file is part of FIFE. * * * * FIFE is free software; you can redistribute it and/or * * modify it under the terms of the GNU Lesser General Public * * License as published by the Free Software Foundation; either * * version 2.1 of the License, or (at your option) any later version. * * * * 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 * * Lesser General Public License for more details. * * * * You should have received a copy of the GNU Lesser General Public * * License along with this library; if not, write to the * * Free Software Foundation, Inc., * * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * ***************************************************************************/ #ifndef FIFE_SOUNDEFFECTMANAGER_H #define FIFE_SOUNDEFFECTMANAGER_H // Standard C++ library includes #include #include // Platform specific includes // 3rd party library includes // FIFE includes // These includes are split up in two parts, separated by one empty line // First block: files included from the FIFE root src directory // Second block: files included from the same folder #include "audio/fife_openal.h" #include "audio/soundconfig.h" namespace FIFE { class SoundEffect; class SoundFilter; class SoundEmitter; class SoundEffectManager { public: /** Constructor */ SoundEffectManager(); /** Destructor */ ~SoundEffectManager(); /** Initializes the effect system */ void init(ALCdevice* device); /** Returns true if sound effect module is active */ bool isActive() const; /** Creates SoundEffect of the specific type. * @param type See SoundEffectType */ SoundEffect* createSoundEffect(SoundEffectType type); /** Creates EaxReverb SoundEffect and loads the specific preset type. * @param type See SoundEffectPreset */ SoundEffect* createSoundEffectPreset(SoundEffectPreset type); /** Deletes given SoundEffect. * Deactivates for SoundEmitters are automatically done. */ void deleteSoundEffect(SoundEffect* effect); /** Enables given SoundEffect. */ void enableSoundEffect(SoundEffect* effect); /** Disables given SoundEffect. */ void disableSoundEffect(SoundEffect* effect); /** Adds given SoundEmitter to the specific SoundEffect. * Note: A SoundEmitter can only have a limited number of effects, usually 4. */ void addEmitterToSoundEffect(SoundEffect* effect, SoundEmitter* emitter); /** Removes given SoundEmitter from the specific SoundEffect. */ void removeEmitterFromSoundEffect(SoundEffect* effect, SoundEmitter* emitter); /** Adds given SoundFilter to the SoundEffect. * Note: A SoundEffect can only have one SoundFilter. */ void addSoundFilterToSoundEffect(SoundEffect* effect, SoundFilter* filter); /** Removes given SoundFilter from the SoundEffect. */ void removeSoundFilterFromSoundEffect(SoundEffect* effect, SoundFilter* filter); /** Internal function to do the OpenAL calls to activate the SoundEffect for the SoundEmitter. */ void activateEffect(SoundEffect* effect, SoundEmitter* emitter); /** Internal function to do the OpenAL calls to deactivate the SoundEffect for the SoundEmitter. */ void deactivateEffect(SoundEffect* effect, SoundEmitter* emitter); /** Creates SoundFilter of the specific type. * @param type See SoundFilterType */ SoundFilter* createSoundFilter(SoundFilterType type); /** Deletes given SoundFilter. * Deactivates for SoundEmitters and Effects are automatically done. */ void deleteSoundFilter(SoundFilter* filter); /** Enables given direct SoundFilter. Only SoundFilters for SoundEmitters are meant. */ void enableDirectSoundFilter(SoundFilter* filter); /** Disables given SoundFilter. Only SoundFilters for SoundEmitters are meant. */ void disableDirectSoundFilter(SoundFilter* filter); /** Adds given SoundEmitter to the specific direct SoundFilter * Note: A SoundEmitter can only have one direct filter. */ void addEmitterToDirectSoundFilter(SoundFilter* filter, SoundEmitter* emitter); /** Removes given SoundEmitter from the specific direct SoundFilter. */ void removeEmitterFromDirectSoundFilter(SoundFilter* filter, SoundEmitter* emitter); /** Internal function to do the OpenAL calls to activate the SoundFilter for the SoundEmitter. */ void activateFilter(SoundFilter* filter, SoundEmitter* emitter); /** Internal function to do the OpenAL calls to deactivate the SoundFilter for the SoundEmitter. */ void deactivateFilter(SoundFilter* filter, SoundEmitter* emitter); private: //! Inital the presets void createPresets(); //! OpenAL device ALCdevice* m_device; //! If sound effect module is active bool m_active; //! Holds handles for effects ALuint m_effectSlots[MAX_EFFECT_SLOTS]; //! Maximal created effect slots, can be different to MAX_EFFECT_SLOTS uint16_t m_createdSlots; //! Holds free handles for effect slots std::queue m_freeSlots; //! Maximal effect slots per Source ALint m_maxSlots; //! Holds all SoundEffects std::vector m_effects; //! Holds SoundEffects together with the added SoundEmitters typedef std::map > SoundEffectEmitterMap; SoundEffectEmitterMap m_effectEmitters; //! Holds all SoundFilters std::vector m_filters; //! Holds SoundFilters together with the added SoundEmitters typedef std::map > SoundFilterEmitterMap; SoundFilterEmitterMap m_filterdEmitters; //! Holds SoundFilters together with the added SoundEffects typedef std::map > SoundFilterEffectMap; SoundFilterEffectMap m_filterdEffects; //! Establishes the relationship between SoundEffectPreset and EFXEAXREVERBPROPERTIES std::map m_presets; }; } #endif