soundfilter.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_SOUNDFILTER_H
#define FIFE_SOUNDFILTER_H

// Standard C++ library includes

// 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 SoundFilter {
    public:
        SoundFilter(SoundFilterType type);

        ~SoundFilter();

        ALuint getFilterId() const;

        void setFilterType(SoundFilterType type);

        SoundFilterType getFilterType() const;

        void setEnabled(bool enabled);

        bool isEnabled() const;

        void setGain(float gain);

        float getGain() const;

        void setGainHf(float gain);

        float getGainHf() const;

        void setGainLf(float gain);

        float getGainLf() const;

    private:
        ALuint m_filter;
        SoundFilterType m_type;
        bool m_enabled;
        float m_gain;
        float m_hGain;
        float m_lGain;
    };
}
#endif