equalizer.h

/* Copyright (c) 2012-2017, Daniel Nachbaur <danielnachbaur@gmail.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * 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 EQFABRIC_EQUALIZER_H
#define EQFABRIC_EQUALIZER_H

#include <eq/fabric/api.h>
#include <eq/fabric/vmmlib.h>

namespace co
{
class DataOStream;
class DataIStream;
}

namespace eq
{
namespace fabric
{
namespace detail
{
class Equalizer;
}

class Equalizer
{
public:
    EQFABRIC_API Equalizer();

    EQFABRIC_API Equalizer(const Equalizer& rhs);

    EQFABRIC_API Equalizer& operator=(const Equalizer& rhs);

    EQFABRIC_API virtual ~Equalizer();

    enum Mode
    {
        MODE_DB = 0,     
        MODE_HORIZONTAL, 
        MODE_VERTICAL,   
        MODE_2D          
    };

    EQFABRIC_API void setFrozen(const bool onOff);

    EQFABRIC_API bool isFrozen() const;

    EQFABRIC_API void setMode(const Mode mode);

    EQFABRIC_API Mode getMode() const;

    EQFABRIC_API void setDamping(const float damping);

    EQFABRIC_API float getDamping() const;

    EQFABRIC_API void setFrameRate(const float frameRate);

    EQFABRIC_API float getFrameRate() const;

    EQFABRIC_API void setBoundary(const Vector2i& boundary);

    EQFABRIC_API void setBoundary(const float boundary);

    EQFABRIC_API const Vector2i& getBoundary2i() const;

    EQFABRIC_API float getBoundaryf() const;

    EQFABRIC_API void setResistance(const Vector2i& resistance);

    EQFABRIC_API void setResistance(const float resistance);

    EQFABRIC_API const Vector2i& getResistance2i() const;

    EQFABRIC_API float getResistancef() const;

    EQFABRIC_API void setAssembleOnlyLimit(const float limit);

    EQFABRIC_API float getAssembleOnlyLimit() const;

    EQFABRIC_API void setTileSize(const Vector2i& size);

    EQFABRIC_API const Vector2i& getTileSize() const;

    EQFABRIC_API void serialize(co::DataOStream& os) const; 
    EQFABRIC_API void deserialize(co::DataIStream& is);     

    EQFABRIC_API void backup();  
    EQFABRIC_API void restore(); 

private:
    detail::Equalizer* _data;
    detail::Equalizer* _backup;
};

EQFABRIC_API co::DataOStream& operator<<(co::DataOStream& os, const Equalizer&);

EQFABRIC_API co::DataIStream& operator>>(co::DataIStream& is, Equalizer&);

EQFABRIC_API std::ostream& operator<<(std::ostream& os, const Equalizer::Mode);
}
}

#endif // EQFABRIC_EQUALIZER_H