surface.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_SURFACE_H
#define GRAPHICS_SURFACE_H

#include "common/scummsys.h"
#include "common/endian.h"
#include "common/list.h"

namespace Common {
struct Rect;
struct Point;
}

#include "graphics/pixelformat.h"

namespace Graphics {

struct TransformStruct;

enum DitherMethod {
    kDitherNaive,
    kDitherFloyd,
    kDitherAtkinson,
    kDitherBurkes,
    kDitherFalseFloyd,
    kDitherSierra,
    kDitherSierraTwoRow,
    kDitherSierraLite,
    kDitherStucki,
    kDitherJarvis,
};

struct Surface {
    int16 w;

    int16 h;

    int32 pitch;

protected:
    void *pixels;

public:
    PixelFormat format;

    Surface() : w(0), h(0), pitch(0), pixels(0), format() {
    }

    inline const void *getPixels() const {
        return pixels;
    }

    inline void *getPixels() {
        return pixels;
    }

    void setPixels(void *newPixels) { pixels = newPixels; }

    inline const void *getBasePtr(int x, int y) const {
        return (const byte *)(pixels) + y * pitch + x * format.bytesPerPixel;
    }

    inline void *getBasePtr(int x, int y) {
        return static_cast<byte *>(pixels) + y * pitch + x * format.bytesPerPixel;
    }

    inline uint32 getPixel(int x, int y) const {
        assert(format.bytesPerPixel > 0 && format.bytesPerPixel <= 4);
        if (format.bytesPerPixel == 1)
            return *((const uint8 *)getBasePtr(x, y));
        else if (format.bytesPerPixel == 2)
            return *((const uint16 *)getBasePtr(x, y));
        else if (format.bytesPerPixel == 3)
            return READ_UINT24(getBasePtr(x, y));
        else if (format.bytesPerPixel == 4)
            return *((const uint32 *)getBasePtr(x, y));
        else
            return 0;
    }

    inline void setPixel(int x, int y, int pixel) {
        assert(format.bytesPerPixel > 0 && format.bytesPerPixel <= 4);
        assert(x >= 0 && x < w && y >= 0 && y < h);
        if (format.bytesPerPixel == 1)
            *((uint8 *)getBasePtr(x, y)) = pixel;
        else if (format.bytesPerPixel == 2)
            *((uint16 *)getBasePtr(x, y)) = pixel;
        else if (format.bytesPerPixel == 3)
            WRITE_UINT24(getBasePtr(x, y), pixel);
        else if (format.bytesPerPixel == 4)
            *((uint32 *)getBasePtr(x, y)) = pixel;
    }

    void create(int16 width, int16 height, const PixelFormat &format);

    void free();

    void init(int16 width, int16 height, int16 pitch, void *pixels, const PixelFormat &format);

    void copyFrom(const Surface &surf);

    void convertFrom(const Surface &surf, const PixelFormat &format);

    Surface getSubArea(const Common::Rect &area);

    const Surface getSubArea(const Common::Rect &area) const;

    bool clip(Common::Rect &srcBounds, Common::Rect &destBounds) const;

    void copyRectToSurface(const void *buffer, int srcPitch, int destX, int destY, int width, int height);
    void copyRectToSurface(const Graphics::Surface &srcSurface, int destX, int destY, const Common::Rect subRect);

    void copyRectToSurfaceWithKey(const void *buffer, int srcPitch, int destX, int destY, int width, int height, uint32 key);

    void copyRectToSurfaceWithKey(const Graphics::Surface &srcSurface, int destX, int destY, const Common::Rect subRect, uint32 key);

    inline void convertToInPlace(const PixelFormat &dstFormat) {
        convertToInPlace(dstFormat, nullptr, 0);
    }

    void convertToInPlace(const PixelFormat &dstFormat, const byte *palette, uint16 paletteCount);

    Graphics::Surface *convertTo(const PixelFormat &dstFormat, const byte *srcPalette = 0, int srcPaletteCount = 0, const byte *dstPalette = 0, int dstPaletteCount = 0, DitherMethod method = kDitherFloyd) const;

protected:
    void ditherFloyd(const byte *srcPalette, int srcPaletteCount, Surface *dstSurf, const byte *dstPalette, int dstPaletteCount, DitherMethod method, const PixelFormat &dstFormat) const;

public:

    void drawLine(int x0, int y0, int x1, int y1, uint32 color);

    void drawThickLine(int x0, int y0, int x1, int y1, int penX, int penY, uint32 color);

    void hLine(int x, int y, int x2, uint32 color);

    void vLine(int x, int y, int y2, uint32 color);

    void fillRect(Common::Rect r, uint32 color);

    void frameRect(const Common::Rect &r, uint32 color);

    void move(int dx, int dy, int height);

    void flipVertical(const Common::Rect &r);

    void flipHorizontal(const Common::Rect &r);

    bool applyColorKey(uint8 rKey, uint8 gKey, uint8 bKey, bool overwriteAlpha = false);

    bool applyColorKey(uint8 rKey, uint8 gKey, uint8 bKey, bool overwriteAlpha,
                       uint8 rNew, uint8 gNew, uint8 bNew);

    bool setAlpha(uint8 alpha, bool skipTransparent = false);

    Graphics::Surface *scale(int16 newWidth, int16 newHeight, bool filtering = false) const;

    Graphics::Surface *rotoscale(const TransformStruct &transform, bool filtering = false) const;

    void debugPrint(int debuglevel = 0, int width = 0, int height = 0, int x = 0, int y = 0, int scale = -1, int maxwidth = 160, const byte *palette = NULL) const;
};

struct SurfaceDeleter {
    void operator()(Surface *ptr) {
        if (ptr) {
            ptr->free();
        }
        delete ptr;
    }
};

class FloodFill {
public:
    FloodFill(Surface *surface, uint32 oldColor, uint32 fillColor, bool maskMode = false);
    ~FloodFill();

    void addSeed(int x, int y);

    void fill();

    void fillMask();

    Surface *getMask() { return _mask; }

private:
    Common::List<Common::Point *> _queue;
    Surface *_surface;
    Surface *_mask;
    uint32 _oldColor, _fillColor;
    byte *_visited;
    int _w, _h;

    bool _maskMode;
};
} // End of namespace Graphics


#endif