pal.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 CINE_PAL_H
#define CINE_PAL_H
 
#include "graphics/pixelformat.h"
 
namespace Cine {
 
enum EndianType {
    CINE_NATIVE_ENDIAN,
    CINE_LITTLE_ENDIAN,
    CINE_BIG_ENDIAN
};
 
struct PalEntry {
    char name[10];
    byte pal1[16];
    byte pal2[16];
};
 
void loadPal(const char *fileName);
 
void loadRelatedPalette(const char *fileName);
 
class Palette {
public:
    struct Color {
        uint8 r, g, b;
    };
 
    Palette(const Graphics::PixelFormat &format = Graphics::PixelFormat(), const uint numColors = 0);
    Palette(const Palette& other);
    Palette& operator=(const Palette& other);
 
    Palette &clear();
 
    Palette &load(const byte *buf, const uint size, const Graphics::PixelFormat &format, const uint numColors, const EndianType endian);
 
    byte *save(byte *buf, const uint size, const EndianType endian) const;
 
    byte *save(byte *buf, const uint size, const Graphics::PixelFormat &format, const EndianType endian) const;
 
    byte *save(byte *buf, const uint size, const Graphics::PixelFormat &format, const uint numColors, const EndianType endian, const byte firstIndex = 0) const;
 
    Palette &rotateRight(byte firstIndex, byte lastIndex);
    Palette &rotateLeft(byte firstIndex, byte lastIndex);
    Palette &saturatedAddColor(Palette &output, byte firstIndex, byte lastIndex, signed r, signed g, signed b) const;
 
    Palette &saturatedAddColor(Palette &output, byte firstIndex, byte lastIndex, signed rSource, signed gSource, signed bSource, const Graphics::PixelFormat &sourceFormat) const;
 
    Palette &saturatedAddNormalizedGray(Palette &output, byte firstIndex, byte lastIndex, signed grayDividend, signed grayDenominator) const;
 
    bool empty() const;
    uint colorCount() const;
    Palette &fillWithBlack();
 
    bool isValid() const;
 
    const Graphics::PixelFormat &colorFormat() const;
 
    void setGlobalOSystemPalette() const;
 
    Color getColor(byte index) const;
 
    uint8 getR(byte index) const;
 
    uint8 getG(byte index) const;
 
    uint8 getB(byte index) const;
 
    bool ensureContrast(byte &minBrightnessColorIndex);
    bool isEqual(byte index1, byte index2);
 
private:
    int findMinBrightnessColorIndex(uint minColorIndex = 1);
    byte brightness(byte colorIndex);
    void setColorFormat(const Graphics::PixelFormat &format);
    void saturatedAddColor(Color &result, const Color &baseColor, signed r, signed g, signed b) const;
 
private:
    Graphics::PixelFormat _format; 
    Common::Array<Color> _colors;  
};
 
} // End of namespace Cine
 
#endif