palette.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_PALETTE_H
#define SCI_GRAPHICS_PALETTE_H

#include "common/array.h"
#include "sci/graphics/helpers.h"
#include "sci/util.h"

namespace Sci {

class ResourceManager;
class GfxScreen;

// Special flag implemented by us for optimization in palette merge
#define SCI_PALETTE_MATCH_PERFECT 0x8000
#define SCI_PALETTE_MATCH_COLORMASK 0xFF

class GfxPalette : public Common::Serializable {
public:
    GfxPalette(ResourceManager *resMan, GfxScreen *screen);
    ~GfxPalette() override;

    bool isMerging();
    bool isUsing16bitColorMatch();

    void setDefault();
    void createFromData(const SciSpan<const byte> &data, Palette *paletteOut) const;
    bool setAmiga();
    void modifyAmigaPalette(const SciSpan<const byte> &data);
    void setEGA();
    void set(Palette *sciPal, bool force, bool forceRealMerge = false, bool includeFirstColor = true);
    bool insert(Palette *newPalette, Palette *destPalette, bool includeFirstColor = false);
    bool merge(Palette *pFrom, bool force, bool forceRealMerge);
    uint16 matchColor(byte r, byte g, byte b, bool force16BitColorMatch = false);

    // Set palette on screen. If update is false, try not to change the palette
    // on already painted areas, but this may be impossible.
    void setOnScreen(bool update=true);
    void copySysPaletteToScreen(bool update);

    void drewPicture(GuiResourceId pictureId);

    bool kernelSetFromResource(GuiResourceId resourceId, bool force);
    void kernelSetFlag(uint16 fromColor, uint16 toColor, uint16 flag);
    void kernelUnsetFlag(uint16 fromColor, uint16 toColor, uint16 flag);
    void kernelSetIntensity(uint16 fromColor, uint16 toColor, uint16 intensity, bool setPalette);
    int16 kernelFindColor(uint16 r, uint16 g, uint16 b, bool force16BitColorMatch = false);
    bool kernelAnimate(byte fromColor, byte toColor, int speed);
    void kernelAnimateSet();
    reg_t kernelSave();
    void kernelRestore(reg_t memoryHandle);
    void kernelAssertPalette(GuiResourceId resourceId);

    void kernelSyncScreenPalette();

    bool kernelPalVaryInit(GuiResourceId resourceId, uint16 ticks, uint16 stepStop, uint16 direction);
    int16 kernelPalVaryReverse(int16 ticks, uint16 stepStop, int16 direction);
    int16 kernelPalVaryGetCurrentStep();
    int16 kernelPalVaryChangeTarget(GuiResourceId resourceId);
    void kernelPalVaryChangeTicks(uint16 ticks);
    void kernelPalVaryPause(bool pause);
    void kernelPalVaryDeinit();
    void palVaryUpdate();
    void palVaryPrepareForTransition();
    void palVaryProcess(int signal, bool setPalette);

    void delayForPalVaryWorkaround();

    Palette _sysPalette;

    void saveLoadWithSerializer(Common::Serializer &s) override;
    void palVarySaveLoadPalette(Common::Serializer &s, Palette *palette);

    byte findMacIconBarColor(byte r, byte g, byte b);
    bool colorIsFromMacClut(byte index);

protected:
    void palVaryInit();
    void palVaryInstallTimer();
    void palVaryRemoveTimer();
    bool palVaryLoadTargetPalette(GuiResourceId resourceId);
    static void palVaryCallback(void *refCon);
    void palVaryIncreaseSignal();

    GfxScreen *_screen;
    ResourceManager *_resMan;

    bool _sysPaletteChanged;
    bool _useMerging;
    bool _use16bitColorMatch;

    Common::Array<PalSchedule> _schedules;

    GuiResourceId _palVaryResourceId;
    Palette _palVaryOriginPalette;
    Palette _palVaryTargetPalette;
    int16 _palVaryStep;
    int16 _palVaryStepStop;
    int16 _palVaryDirection;
    uint16 _palVaryTicks;
    int _palVaryPaused;
    int _palVarySignal;
    bool _palVaryZeroTick;
    uint16 _totalScreenColors;

    void loadMacIconBarPalette();
    byte *_macClut;
};

} // End of namespace Sci

#endif // SCI_GRAPHICS_PALETTE_H