path: root/engines/sword25/gfx/image/pngloader.cpp

/* 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 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.
 *
 * $URL$
 * $Id$
 *
 */

/*
 * This code is based on Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

#include "sword25/gfx/image/image.h"
#include "sword25/gfx/image/pngloader.h"
#include <png.h>

namespace Sword25 {

#define BS_LOG_PREFIX "PNGLOADER"

PNGLoader::PNGLoader() {
}

static void png_user_read_data(png_structp png_ptr, png_bytep data, png_size_t length) {
	const byte **ref = (const byte **)png_get_io_ptr(png_ptr);
	memcpy(data, *ref, length);
	*ref += length;
}

bool PNGLoader::doDecodeImage(const byte *fileDataPtr, uint fileSize,  GraphicEngine::COLOR_FORMATS colorFormat, byte *&uncompressedDataPtr, int &width, int &height, int &pitch) {
	png_structp png_ptr = NULL;
	png_infop   info_ptr = NULL;
	png_bytep   rawDataBuffer = NULL;
	png_bytep  *pRowPtr = NULL;

	int         bitDepth;
	int         colorType;
	int         interlaceType;
	int         i;

	// Zielfarbformat �berpr�fen
	if (colorFormat != GraphicEngine::CF_ARGB32) {
		BS_LOG_ERRORLN("Illegal or unsupported color format.");
		return false;
	}

	// PNG Signatur �berpr�fen
	if (!png_check_sig(reinterpret_cast<png_bytep>(const_cast<byte *>(fileDataPtr)), 8)) {
		error("png_check_sig failed");
	}

	// Die beiden PNG Strukturen erstellen
	png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
	if (!png_ptr) {
		error("Could not create libpng read struct.");
	}

	info_ptr = png_create_info_struct(png_ptr);
	if (!info_ptr) {
		error("Could not create libpng info struct.");
	}

	// Alternative Lesefunktion benutzen
	const byte **ref = &fileDataPtr;
	png_set_read_fn(png_ptr, (void *)ref, png_user_read_data);

	// PNG Header einlesen
	png_read_info(png_ptr, info_ptr);

	// PNG Informationen auslesen
	png_get_IHDR(png_ptr, info_ptr, (png_uint_32 *)&width, (png_uint_32 *)&height, &bitDepth, &colorType, &interlaceType, NULL, NULL);

	// Pitch des Ausgabebildes berechnen
	pitch = GraphicEngine::calcPitch(colorFormat, width);

	// Speicher f�r die endg�ltigen Bilddaten reservieren
	// Dieses geschieht vor dem reservieren von Speicher f�r tempor�re Bilddaten um die Fragmentierung des Speichers gering zu halten
	uncompressedDataPtr = new byte[pitch * height];
	if (!uncompressedDataPtr) {
		error("Could not allocate memory for output image.");
	}

	// Bilder jeglicher Farbformate werden zun�chst in ARGB Bilder umgewandelt
	if (bitDepth == 16)
		png_set_strip_16(png_ptr);
	if (colorType == PNG_COLOR_TYPE_PALETTE)
		png_set_expand(png_ptr);
	if (bitDepth < 8)
		png_set_expand(png_ptr);
	if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
		png_set_expand(png_ptr);
	if (colorType == PNG_COLOR_TYPE_GRAY ||
	        colorType == PNG_COLOR_TYPE_GRAY_ALPHA)
		png_set_gray_to_rgb(png_ptr);

	png_set_bgr(png_ptr);

	if (colorType != PNG_COLOR_TYPE_RGB_ALPHA)
		png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);

	// Nachdem die Transformationen registriert wurden, werden die Bilddaten erneut eingelesen
	png_read_update_info(png_ptr, info_ptr);
	png_get_IHDR(png_ptr, info_ptr, (png_uint_32 *)&width, (png_uint_32 *)&height, &bitDepth, &colorType, NULL, NULL, NULL);

	// PNGs ohne Interlacing werden Zeilenweise eingelesen
	if (interlaceType == PNG_INTERLACE_NONE) {
		// Speicher f�r eine Bildzeile reservieren
		rawDataBuffer = new png_byte[png_get_rowbytes(png_ptr, info_ptr)];
		if (!rawDataBuffer) {
			error("Could not allocate memory for row buffer.");
		}

		// Bilddaten zeilenweise einlesen und in das gew�nschte Zielformat konvertieren
		for (i = 0; i < height; i++) {
			// Zeile einlesen
			png_read_row(png_ptr, rawDataBuffer, NULL);

			// Zeile konvertieren
			switch (colorFormat) {
			case GraphicEngine::CF_ARGB32:
				memcpy(&uncompressedDataPtr[i * pitch], rawDataBuffer, pitch);
				break;
			default:
				assert(0);
			}
		}
	} else {
		// PNGs mit Interlacing werden an einem St�ck eingelesen
		// Speicher f�r das komplette Bild reservieren
		rawDataBuffer = new png_byte[png_get_rowbytes(png_ptr, info_ptr) * height];
		if (!rawDataBuffer) {
			error("Could not allocate memory for raw image buffer.");
		}

		// Speicher f�r die Rowpointer reservieren
		pRowPtr = new png_bytep[height];
		if (!pRowPtr) {
			error("Could not allocate memory for row pointers.");
		}

		// Alle Rowpointer mit den richtigen Offsets initialisieren
		for (i = 0; i < height; i++)
			pRowPtr[i] = rawDataBuffer + i * png_get_rowbytes(png_ptr, info_ptr);

		// Bild einlesen
		png_read_image(png_ptr, pRowPtr);

		// Bilddaten zeilenweise in das gew�nschte Ausgabeformat konvertieren
		switch (colorFormat) {
		case GraphicEngine::CF_ARGB32:
			for (i = 0; i < height; i++)
				memcpy(&uncompressedDataPtr[i * pitch], &rawDataBuffer[i * png_get_rowbytes(png_ptr, info_ptr)], pitch);
			break;
		default:
			error("Unhandled case in DoDecodeImage");
			break;
		}
	}

	// Die zus�tzlichen Daten am Ende des Bildes lesen
	png_read_end(png_ptr, NULL);

	// Die Strukturen freigeben
	png_destroy_read_struct(&png_ptr, &info_ptr, NULL);

	// Tempor�re Buffer freigeben
	delete[] pRowPtr;
	delete[] rawDataBuffer;

	// Der Funktionsaufruf war erfolgreich
	return true;
}

bool PNGLoader::decodeImage(const byte *fileDataPtr, uint fileSize,  GraphicEngine::COLOR_FORMATS colorFormat, byte *&uncompressedDataPtr, int &width, int &height, int &pitch) {
	return doDecodeImage(fileDataPtr, fileSize, colorFormat, uncompressedDataPtr, width, height, pitch);
}

bool PNGLoader::doImageProperties(const byte *fileDataPtr, uint fileSize, GraphicEngine::COLOR_FORMATS &colorFormat, int &width, int &height) {
	// PNG Signatur �berpr�fen
	if (!doIsCorrectImageFormat(fileDataPtr, fileSize))
		return false;

	png_structp png_ptr = NULL;
	png_infop info_ptr = NULL;

	// Die beiden PNG Strukturen erstellen
	png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
	if (!png_ptr) {
		error("Could not create libpng read struct.");
	}

	info_ptr = png_create_info_struct(png_ptr);
	if (!info_ptr) {
		error("Could not create libpng info struct.");
	}

	// Alternative Lesefunktion benutzen
	const byte **ref = &fileDataPtr;
	png_set_read_fn(png_ptr, (void *)ref, png_user_read_data);

	// PNG Header einlesen
	png_read_info(png_ptr, info_ptr);

	// PNG Informationen auslesen
	int bitDepth;
	int colorType;
	png_get_IHDR(png_ptr, info_ptr, (png_uint_32 *)&width, (png_uint_32 *)&height, &bitDepth, &colorType, NULL, NULL, NULL);

	// PNG-ColorType in BS ColorFormat konvertieren.
	if (colorType & PNG_COLOR_MASK_ALPHA || png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
		colorFormat = GraphicEngine::CF_ARGB32;
	else
		colorFormat = GraphicEngine::CF_RGB24;

	// Die Strukturen freigeben
	png_destroy_read_struct(&png_ptr, &info_ptr, NULL);

	return true;

}

bool PNGLoader::imageProperties(const byte *fileDataPtr, uint fileSize, GraphicEngine::COLOR_FORMATS &colorFormat, int &width, int &height) {
	return doImageProperties(fileDataPtr, fileSize, colorFormat, width, height);
}

bool PNGLoader::doIsCorrectImageFormat(const byte *fileDataPtr, uint fileSize) {
	if (fileSize > 8)
		return png_check_sig(const_cast<byte *>(fileDataPtr), 8) ? true : false;
	else
		return false;
}

bool PNGLoader::isCorrectImageFormat(const byte *fileDataPtr, uint fileSize) {
	return doIsCorrectImageFormat(fileDataPtr, fileSize);
}

} // End of namespace Sword25