rainmeter-studio/Library/TintedImage.h

/*
  Copyright (C) 2010 Kimmo Pekkola, Matt King, spx

  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 2
  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, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
*/

#ifndef __TINTEDIMAGE_H__
#define __TINTEDIMAGE_H__

#include <windows.h>
#include <gdiplus.h>
#include <string>

/*
** CTintedImageHelper_DefineConfigArray macro
**
** This is a helper macro to define the array of the config item.
** It's necessary to give a string literal to the prefix parameter.
**
*/
#define CTintedImageHelper_DefineConfigArray(name, prefix) \
	const WCHAR* (name)[CTintedImage::ConfigCount] = { \
		prefix  L"ImageCrop", \
		prefix  L"Greyscale", \
		prefix  L"ImageTint", \
		prefix  L"ImageAlpha", \
		prefix  L"ColorMatrix1", \
		prefix  L"ColorMatrix2", \
		prefix  L"ColorMatrix3", \
		prefix  L"ColorMatrix4", \
		prefix  L"ColorMatrix5", \
		prefix  L"ImageFlip", \
		prefix  L"ImageRotate" \
	};

class CConfigParser;

class CTintedImage
{
public:
	enum ConfigIndex
	{
		ConfigIndexImageCrop = 0,
		ConfigIndexGreyscale,
		ConfigIndexImageTint,
		ConfigIndexImageAlpha,
		ConfigIndexColorMatrix1,
		ConfigIndexColorMatrix2,
		ConfigIndexColorMatrix3,
		ConfigIndexColorMatrix4,
		ConfigIndexColorMatrix5,
		ConfigIndexImageFlip,
		ConfigIndexImageRotate,

		ConfigCount
	};

	CTintedImage(const WCHAR* name = L"Image", const WCHAR** configArray = c_DefaultConfigArray, bool disableTransform = false);
	~CTintedImage();

	void ReadConfig(CConfigParser& parser, const WCHAR* section);

	bool IsLoaded() { return (m_Bitmap != NULL); }
	bool IsTinted() { return (m_BitmapTint != NULL); }
	bool IsConfigsChanged() { return m_NeedsCrop || m_NeedsTinting || m_NeedsTransform; }
	void ClearConfigFlags() { m_NeedsCrop = m_NeedsTinting = m_NeedsTransform = false; }

	Gdiplus::Bitmap* GetOriginalImage() { return m_Bitmap; }
	Gdiplus::Bitmap* GetTintedImage() { return m_BitmapTint; }
	Gdiplus::Bitmap* GetImage() { return (m_BitmapTint) ? m_BitmapTint : m_Bitmap; }

	void DisposeImage();
	void LoadImage(const std::wstring& imageName, bool bLoadAlways);

protected:
	enum CROPMODE
	{
		CROPMODE_TL = 1,
		CROPMODE_TR,
		CROPMODE_BR,
		CROPMODE_BL,
		CROPMODE_C
	};

	void ApplyCrop();
	void ApplyTint();
	void ApplyTransform();

	Gdiplus::Bitmap* LoadImageFromFileHandle(HANDLE fileHandle, DWORD fileSize, HGLOBAL* phBuffer);

	static Gdiplus::Bitmap* TurnGreyscale(Gdiplus::Bitmap* source);
	static bool CompareColorMatrix(const Gdiplus::ColorMatrix* a, const Gdiplus::ColorMatrix* b);

	Gdiplus::Bitmap* m_Bitmap;			// The bitmap
	Gdiplus::Bitmap* m_BitmapTint;		// The tinted bitmap

	const std::wstring m_ConfigName;
	const WCHAR** m_ConfigArray;
	const bool m_DisableTransform;

	bool m_NeedsCrop;
	bool m_NeedsTinting;
	bool m_NeedsTransform;

	Gdiplus::Rect m_Crop;
	CROPMODE m_CropMode;
	bool m_GreyScale;
	Gdiplus::ColorMatrix* m_ColorMatrix;
	Gdiplus::RotateFlipType m_Flip;
	Gdiplus::REAL m_Rotate;

	std::wstring m_CacheKey;

	static const Gdiplus::ColorMatrix c_GreyScaleMatrix;
	static const Gdiplus::ColorMatrix c_IdentityMatrix;

	static const WCHAR* c_DefaultConfigArray[ConfigCount];
};

#endif