/***************************************************************************
 *   Copyright (C) 2010-2012 by Ilya Kotov                                 *
 *   forkotov02@hotmail.ru                                                 *
 *                                                                         *
 *   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 program 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.                          *
 *                                                                         *
 *   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.         *
 ***************************************************************************/

#ifndef EQSETTINGS_H
#define EQSETTINGS_H

/*! @brief The EqSettings class helps to work with equalizer settings.
     * @author Ilya Kotov <forkotov02@hotmail.ru>
     */
class EqSettings
{
public:
    /*!
     * Constructs an empty equalizer settings (0 dB, disabled)
     * @param bands - Number of bands (supported: 10, 15, 25, 31)
     */
    EqSettings(int bands = EQ_BANDS_10);
    /*!
     * Returns \b true if equalizer os enabled, otherwise returns \b false.
     */
    bool isEnabled() const;
    /*!
     * Returns gain of the channel number \b chan.
     */
    double gain(int chan) const;
    /*!
     * Returns equalizer preamp.
     */
    double preamp() const;
    /*!
     * Returns number of bands
     */
    int bands() const;
    /*!
     *  Enables equalizer if \p enabled is \b true or disables it if \p enabled is \b false.
     */
    void setEnabled(bool enabled = true);
    /*!
     * Sets gain of the equalizer channel.
     * @param band Number of equalizer band.
     * @param gain Channel gain (-20.0..20.0 dB)
     */
    void setGain(int band, double gain);
    /*!
     * Sets equalizer preamp to \b preamp.
     */
    void setPreamp(double preamp);
    /*!
     * Assigns equalizer settings \b s to this settings.
     */
    void operator=(const EqSettings &s);
    /*!
     * Returns \b true if equalizer settins \b s is equal to this settings; otherwise returns false.
     */
    bool operator==(const EqSettings &s) const;
    /*!
     * Returns \b true if equalizer settins \b s is not equal to this settings; otherwise returns false.
     */
    bool operator!=(const EqSettings &s) const;
    /*!
     * Equalizer bands number
     */
    enum BANDS
    {
        EQ_BANDS_10 = 10, /*!< 10 bands */
        EQ_BANDS_15 = 15, /*!< 15 bands */
        EQ_BANDS_25 = 25, /*!< 25 bands */
        EQ_BANDS_31 = 31  /*!< 31 bands */
    };

private:
    double m_gains[31];
    double m_preamp;
    bool m_is_enabled;
    int m_bands;
};

#endif // EQSETTINGS_H
