view.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 SCI_GRAPHICS_VIEW_H
#define SCI_GRAPHICS_VIEW_H

#include "sci/util.h"

namespace Sci {

struct CelInfo {
    int16 width, height;
    int16 scriptWidth, scriptHeight;
    int16 displaceX;
    int16 displaceY;
    byte clearKey;
    uint16 offsetEGA;
    uint32 offsetRLE;
    uint32 offsetLiteral;
    Common::SpanOwner<SciSpan<const byte> > rawBitmap;
};

struct LoopInfo {
    bool mirrorFlag;
    Common::Array<CelInfo> cel;
};

enum {
    SCI_VIEW_EGAMAPPING_SIZE = 16,
    SCI_VIEW_EGAMAPPING_COUNT = 8
};

class GfxScreen;
class GfxPalette;
class Resource;

class GfxView {
public:
    GfxView(ResourceManager *resMan, GfxScreen *screen, GfxPalette *palette, GuiResourceId resourceId);
    ~GfxView();

    GuiResourceId getResourceId() const;
    int16 getWidth(int16 loopNo, int16 celNo) const;
    int16 getHeight(int16 loopNo, int16 celNo) const;
    const CelInfo *getCelInfo(int16 loopNo, int16 celNo) const;
    void getCelRect(int16 loopNo, int16 celNo, int16 x, int16 y, int16 z, Common::Rect &outRect) const;
    void getCelSpecialHoyle4Rect(int16 loopNo, int16 celNo, int16 x, int16 y, int16 z, Common::Rect &outRect) const;
    void getCelScaledRect(int16 loopNo, int16 celNo, int16 x, int16 y, int16 z, int16 scaleX, int16 scaleY, Common::Rect &outRect) const;
    const SciSpan<const byte> &getBitmap(int16 loopNo, int16 celNo);
    void draw(const Common::Rect &rect, const Common::Rect &clipRect, const Common::Rect &clipRectTranslated, int16 loopNo, int16 celNo, byte priority, uint16 EGAmappingNr, bool upscaledHires, uint16 scaleSignal = 0);
    void drawScaled(const Common::Rect &rect, const Common::Rect &clipRect, const Common::Rect &clipRectTranslated, int16 loopNo, int16 celNo, byte priority, int16 scaleX, int16 scaleY, uint16 scaleSignal = 0);
    uint16 getLoopCount() const { return _loop.size(); }
    uint16 getCelCount(int16 loopNo) const;
    Palette *getPalette();

    bool isScaleable();

    void adjustToUpscaledCoordinates(int16 &y, int16 &x);
    void adjustBackUpscaledCoordinates(int16 &y, int16 &x);

private:
    void initData();
    void unpackCel(int16 loopNo, int16 celNo, SciSpan<byte> &outPtr);
    void unditherBitmap(SciSpan<byte> &bitmap, int16 width, int16 height, byte clearKey);
    byte getMappedColor(byte color, uint16 scaleSignal, const Palette *palette, int x2, int y2);

    static void createScalingTable(Common::Array<uint16> &table, int16 celSize, uint16 maxSize, int16 scale, bool mirrorFlag);

    ResourceManager *_resMan;
    GfxCoordAdjuster16 *_coordAdjuster;
    GfxScreen *_screen;
    GfxPalette *_palette;

    GuiResourceId _resourceId;
    Resource *_resource;

    Common::Array<LoopInfo> _loop;
    bool _embeddedPal;
    Palette _viewPalette;

    SciSpan<const byte> _EGAmapping;

    // this is set for sci0early to adjust for the getCelRect() change
    int16 _adjustForSci0Early;

    // this is not set for some views in laura bow 2 floppy and signals that the view shall never get scaled
    //  even if scaleX/Y are set (inside kAnimate)
    bool _isScaleable;
};

} // End of namespace Sci

#endif // SCI_GRAPHICS_VIEW_H