soundmanager.h

Go to the documentation of this file.

/***************************************************************************
 *   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_SOUNDMANAGER_H
#define FIFE_SOUNDMANAGER_H

// Standard C++ library includes
#include <queue>

// 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 "model/metamodel/modelcoords.h"
#include "util/base/singleton.h"

#include "fife_openal.h"
#include "soundconfig.h"

namespace FIFE {

    enum SoundDistanceModelType {
        SD_DISTANCE_NONE,
        SD_DISTANCE_INVERSE,
        SD_DISTANCE_INVERSE_CLAMPED,
        SD_DISTANCE_LINEAR,
        SD_DISTANCE_LINEAR_CLAMPED,
        SD_DISTANCE_EXPONENT,
        SD_DISTANCE_EXPONENT_CLAMPED
    };

    enum SoundManagerState {
        SM_STATE_INACTIV,
        SM_STATE_PLAY,
        SM_STATE_PAUSE,
        SM_STATE_STOP
    };

    class SoundEffectManager;
    class SoundEffect;
    class SoundFilter;
    class SoundEmitter;

    class SoundManager : public DynamicSingleton<SoundManager> {
    public:

        SoundManager();

        ~SoundManager();

        void init();

        bool isActive() const;

        ALCcontext* getContext() const;

        void setVolume(float vol);

        float getVolume() const;

        void mute();

        void unmute();

        void play();

        void pause();

        void stop();

        void rewind();

        void setDistanceModel(SoundDistanceModelType model);

        SoundDistanceModelType getDistanceModel() const;

        void setListenerPosition(const AudioSpaceCoordinate& position);

        AudioSpaceCoordinate getListenerPosition() const;

        void setListenerOrientation(const AudioSpaceCoordinate& orientation);

        AudioSpaceCoordinate getListenerOrientation() const;

        void setListenerVelocity(const AudioSpaceCoordinate& velocity);

        AudioSpaceCoordinate getListenerVelocity() const;

        void setDopplerFactor(float factor);

        float getDopplerFactor() const;

        void setListenerMaxDistance(float distance);

        float getListenerMaxDistance() const;

        void update();

        SoundEmitter* getEmitter(uint32_t emitterId) const;

        SoundEmitter* createEmitter();

        SoundEmitter* createEmitter(const std::string& name);

        void releaseEmitter(uint32_t emitterId);

        void deleteEmitter(SoundEmitter* emitter);

        void releaseSource(SoundEmitter* emitter);

        SoundEffect* createSoundEffect(SoundEffectType type);

        SoundEffect* createSoundEffectPreset(SoundEffectPreset type);

        void deleteSoundEffect(SoundEffect* effect);

        void enableSoundEffect(SoundEffect* effect);

        void disableSoundEffect(SoundEffect* effect);

        void addEmitterToSoundEffect(SoundEffect* effect, SoundEmitter* emitter);

        void removeEmitterFromSoundEffect(SoundEffect* effect, SoundEmitter* emitter);

        void addSoundFilterToSoundEffect(SoundEffect* effect, SoundFilter* filter);

        void removeSoundFilterFromSoundEffect(SoundEffect* effect, SoundFilter* filter);

        void activateEffect(SoundEffect* effect, SoundEmitter* emitter);

        void deactivateEffect(SoundEffect* effect, SoundEmitter* emitter);

        SoundFilter* createSoundFilter(SoundFilterType type);

        void deleteSoundFilter(SoundFilter* filter);

        void enableDirectSoundFilter(SoundFilter* filter);

        void disableDirectSoundFilter(SoundFilter* filter);

        void addEmitterToDirectSoundFilter(SoundFilter* filter, SoundEmitter* emitter);

        void removeEmitterFromDirectSoundFilter(SoundFilter* filter, SoundEmitter* emitter);

        void activateFilter(SoundFilter* filter, SoundEmitter* emitter);

        void deactivateFilter(SoundFilter* filter, SoundEmitter* emitter);

        void addToGroup(SoundEmitter* emitter);
        
        void removeFromGroup(SoundEmitter* emitter);

        void removeGroup(const std::string& group);

        void removeAllGroups();

        void play(const std::string& group);

        void pause(const std::string& group);

        void stop(const std::string& group);

        void rewind(const std::string& group);

        void setGain(const std::string& group, float gain);

        void setMaxGain(const std::string& group, float gain);

        void setMinGain(const std::string& group, float gain);

    private:
        typedef std::map<std::string, std::vector<SoundEmitter*> > EmitterGroups;
        typedef EmitterGroups::iterator EmitterGroupsIterator;

        void setEmitterSource(SoundEmitter* emitter);

        std::vector<SoundEmitter*> m_emitterVec;
        ALCcontext* m_context;
        ALCdevice* m_device;
        float m_muteVol;
        float m_volume;
        float m_maxDistance;
        SoundDistanceModelType m_distanceModel;
        SoundManagerState m_state;

        ALuint m_sources[MAX_SOURCES];
        uint16_t m_createdSources;
        std::queue<ALuint> m_freeSources;
        std::map<SoundEmitter*, ALuint> m_activeEmitters;

        SoundEffectManager* m_effectManager;

        EmitterGroups m_groups;
    };
}
#endif