transitions32.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_TRANSITIONS32_H
#define SCI_GRAPHICS_TRANSITIONS32_H

#include "common/list.h"
#include "common/scummsys.h"
#include "sci/engine/vm_types.h"

namespace Sci {
enum ShowStyleType {
    kShowStyleNone = 0,
    kShowStyleHShutterOut = 1,
    kShowStyleHShutterIn = 2,
    kShowStyleVShutterOut = 3,
    kShowStyleVShutterIn = 4,
    kShowStyleWipeLeft = 5,
    kShowStyleWipeRight = 6,
    kShowStyleWipeUp = 7,
    kShowStyleWipeDown = 8,
    kShowStyleIrisOut = 9,
    kShowStyleIrisIn = 10,
    kShowStyleDissolveNoMorph = 11,
    kShowStyleDissolve = 12,
    kShowStyleFadeOut = 13,
    kShowStyleFadeIn = 14,
    kShowStyleMorph = 15
};

struct PlaneShowStyle {
    reg_t plane;

    ShowStyleType type;

    bool fadeUp;

    int16 divisions;

    int16 color;

    int delay;

    bool animate;

    uint32 nextTick;

    int currentStep;

    bool processed;

    //
    // Engine specific properties for SCI2.1early
    //

    Common::Array<ScreenItem *> screenItems;

    uint8 numEdges;

    int16 width, height;

    ScreenItem *bitmapScreenItem;

    reg_t bitmap;

    uint32 dissolveMask;

    uint32 firstPixel;

    uint32 pixel;

    //
    // Engine specific properties for SCI2.1mid through SCI3
    //

    Common::Array<uint16> fadeColorRanges;
};

struct PlaneScroll {
    reg_t plane;

    int16 x, y;

    int16 deltaX, deltaY;

    GuiResourceId newPictureId;

    GuiResourceId oldPictureId;

    bool animate;

    uint32 startTick;
};

typedef Common::List<PlaneShowStyle> ShowStyleList;
typedef Common::List<PlaneScroll> ScrollList;

class GfxTransitions32 {
public:
    GfxTransitions32(SegManager *_segMan);
    ~GfxTransitions32();

private:
    SegManager *_segMan;

    void throttle(const uint32 ms = 10);

    void clearShowRects();
    void addShowRect(const Common::Rect &rect);
    void sendShowRects();

#pragma mark -
#pragma mark Show styles
public:
    inline bool hasShowStyles() const { return !_showStyles.empty(); }

    void processShowStyles();

    void processEffects(PlaneShowStyle &showStyle);

    void kernelSetShowStyle(const reg_t planeObj, const ShowStyleType type, const int16 seconds,
        const int16 direction, const int16 priority, const int16 animate, const int16 frameOutNow,
        const reg_t pFadeArray, const int16 divisions, const int16 blackScreen);

    void kernelSetPalStyleRange(const uint8 fromColor, const uint8 toColor);

    int8 _styleRanges[256];

private:
    int *_dissolveSequenceSeeds;

    int16 *_defaultDivisions;

    ShowStyleList _showStyles;

    PlaneShowStyle *findShowStyleForPlane(const reg_t planeObj);

    ShowStyleList::iterator findIteratorForPlane(const reg_t planeObj);

    ShowStyleList::iterator deleteShowStyle(const ShowStyleList::iterator &showStyle);

    void configure21EarlyHorizontalWipe(PlaneShowStyle &showStyle, const int16 priority);

    void configure21EarlyHorizontalShutter(PlaneShowStyle &showStyle, const int16 priority);

    void configure21EarlyIris(PlaneShowStyle &showStyle, const int16 priority);

    void configure21EarlyDissolve(PlaneShowStyle &showStyle, const int16 priority, const Common::Rect &gameRect);

    bool processShowStyle(PlaneShowStyle &showStyle, uint32 now);

    bool processNone(PlaneShowStyle &showStyle);

    bool processHShutterOut(PlaneShowStyle &showStyle);

    void processHShutterIn(const PlaneShowStyle &showStyle);

    void processVShutterOut(PlaneShowStyle &showStyle);

    void processVShutterIn(PlaneShowStyle &showStyle);

    void processWipeLeft(PlaneShowStyle &showStyle);

    void processWipeRight(PlaneShowStyle &showStyle);

    void processWipeUp(PlaneShowStyle &showStyle);

    void processWipeDown(PlaneShowStyle &showStyle);

    bool processIrisOut(PlaneShowStyle &showStyle);

    bool processIrisIn(PlaneShowStyle &showStyle);

#if 0

    void processDissolveNoMorph(PlaneShowStyle &showStyle);
#endif

    bool processPixelDissolve(PlaneShowStyle &showStyle);

    bool processPixelDissolve21Early(PlaneShowStyle &showStyle);

    bool processPixelDissolve21Mid(const PlaneShowStyle &showStyle);

    bool processFade(const int8 direction, PlaneShowStyle &showStyle);

    bool processMorph(PlaneShowStyle &showStyle);

    bool processWipe(const int8 direction, PlaneShowStyle &showStyle);

#pragma mark -
#pragma mark Scrolls
public:
    inline bool hasScrolls() const { return !_scrolls.empty(); }

    void processScrolls();

    void kernelSetScroll(const reg_t plane, const int16 deltaX, const int16 deltaY, const GuiResourceId pictureId, const bool animate, const bool mirrorX);

private:
    ScrollList _scrolls;

    bool processScroll(PlaneScroll &scroll);
};

} // End of namespace Sci

#endif // SCI_GRAPHICS_TRANSITIONS32_H