scalerplugin.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef GRAPHICS_SCALERPLUGIN_H
#define GRAPHICS_SCALERPLUGIN_H

#include "base/plugins.h"
#include "graphics/pixelformat.h"
#include "graphics/surface.h"

class Scaler {
public:
    Scaler(const Graphics::PixelFormat &format) : _format(format) {}
    virtual ~Scaler() {}

    void scale(const uint8 *srcPtr, uint32 srcPitch, uint8 *dstPtr,
               uint32 dstPitch, int width, int height, int x, int y);

    virtual uint increaseFactor() = 0;

    virtual uint decreaseFactor() = 0;

    virtual uint getFactor() const { return _factor; }

    virtual uint setFactor(uint factor) {
        uint oldFactor = _factor;
        _factor = factor;
        return oldFactor;
    }

    virtual void setSource(const byte *src, uint pitch, int width, int height, int padding) {
        // Should not be called unless overriden
        assert(0);
    }

    virtual void enableSource(bool enable) {
        // Should not be called unless overriden
        assert(0);
    }

protected:
    virtual void scaleIntern(const uint8 *srcPtr, uint32 srcPitch, uint8 *dstPtr,
                             uint32 dstPitch, int width, int height, int x, int y) = 0;

    uint _factor;
    Graphics::PixelFormat _format;
};

class SourceScaler : public Scaler {

public:

    SourceScaler(const Graphics::PixelFormat &format);
    virtual ~SourceScaler();

    virtual void setSource(const byte *src, uint pitch, int width, int height, int padding) final;

    virtual void enableSource(bool enable) final { _enable = enable; }

    virtual uint setFactor(uint factor) final;

protected:

    virtual void scaleIntern(const uint8 *srcPtr, uint32 srcPitch, uint8 *dstPtr,
                             uint32 dstPitch, int width, int height, int x, int y) final;

    virtual void internScale(const uint8 *srcPtr, uint32 srcPitch,
                             uint8 *dstPtr, uint32 dstPitch,
                             const uint8 *oldSrcPtr, uint32 oldSrcPitch,
                             int width, int height, const uint8 *buffer, uint32 bufferPitch) = 0;

private:

    int _width, _height, _padding;
    bool _enable;
    byte *_oldSrc;
    Graphics::Surface _bufferedOutput;
};

class ScalerPluginObject : public PluginObject {
public:

    virtual ~ScalerPluginObject() {}

    virtual Scaler *createInstance(const Graphics::PixelFormat &format) const = 0;

    const Common::Array<uint> &getFactors() const { return _factors; }

    bool hasFactor(uint factor) const {
        const Common::Array<uint> &factors = getFactors();
        for (Common::Array<uint>::const_iterator it = factors.begin(); it != factors.end(); it++) {
            if ((*it) == factor)
                return true;
        }

        return false;
    }

    virtual uint extraPixels() const = 0;

    virtual bool canDrawCursor() const = 0;

    virtual const char *getPrettyName() const = 0;

    virtual uint getDefaultFactor() const { return 2; }

    virtual bool useOldSource() const { return false; }

protected:
    Common::Array<uint> _factors;
};

class ScalerManager : public Common::Singleton<ScalerManager> {
private:
    friend class Common::Singleton<SingletonBaseType>;

public:
    const PluginList &getPlugins() const;

    uint getMaxExtraPixels() const;

    Plugin *findScalerPlugin(const char *name) const;

    uint findScalerPluginIndex(const char *name) const;

    void updateOldSettings();

    bool isOldGraphicsSetting(const Common::String &gfxMode);
};

#define ScalerMan ScalerManager::instance()

#endif