SWORD25: Add ImageLoaderManager, get rid of last globally constructed object

This also gets rid of an evil use of atexit.

svn-id: r53753
This commit is contained in:
Max Horn 2010-10-24 01:30:53 +00:00
parent 2da4469686
commit 85e3ddc309
9 changed files with 113 additions and 200 deletions

View File

@ -71,7 +71,7 @@ typedef uint BS_COLOR;
/**
* This is the graphics engine. Unlike the original code, this is not
* an interface that needs to be subclasses, but rather already contains
* an interface that needs to be subclassed, but rather already contains
* all required functionality.
*/
class GraphicEngine : public ResourceService, public Persistable {

View File

@ -41,11 +41,7 @@
namespace Sword25 {
class B25SLoader : public ImageLoader {
public:
static ImageLoader *createInstance() {
return static_cast<ImageLoader *>(new B25SLoader());
}
friend class ImageLoaderManager;
protected:
virtual bool isCorrectImageFormat(const byte *fileDataPtr, uint fileSize);
virtual bool decodeImage(const byte *fileDataPtr, uint fileSize, GraphicEngine::COLOR_FORMATS colorFormat, byte *&uncompressedDataPtr, int &width, int &height, int &pitch);

View File

@ -33,26 +33,24 @@
*/
#include "sword25/gfx/image/imageloader.h"
#include "sword25/gfx/image/imageloader_ids.h"
#include "sword25/gfx/image/pngloader.h"
#include "sword25/gfx/image/b25sloader.h"
DECLARE_SINGLETON(Sword25::ImageLoaderManager)
namespace Sword25 {
#define BS_LOG_PREFIX "IMAGELOADER"
// Statische Elemente der Klasse BS_ImageLoader intialisieren.
Common::List<ImageLoader *> ImageLoader::_imageLoaderList;
bool ImageLoader::_imageLoaderListInitialized = false;
bool ImageLoader::loadImage(const byte *pFileData, uint fileSize,
bool ImageLoaderManager::loadImage(const byte *pFileData, uint fileSize,
GraphicEngine::COLOR_FORMATS colorFormat,
byte *&pUncompressedData,
int &width, int &height,
int &pitch) {
// Falls die Liste der BS_ImageLoader noch nicht initialisiert wurde, wird dies getan.
if (!_imageLoaderListInitialized)
initializeLoaderList();
// Passenden BS_ImageLoader finden und Bild dekodieren
// Find a suitable ImageLoader and decode the image
ImageLoader *pLoader = findSuitableImageLoader(pFileData, fileSize);
if (pLoader) {
return pLoader->decodeImage(pFileData, fileSize,
@ -65,14 +63,11 @@ bool ImageLoader::loadImage(const byte *pFileData, uint fileSize,
return false;
}
bool ImageLoader::extractImageProperties(const byte *pFileData, uint fileSize,
bool ImageLoaderManager::extractImageProperties(const byte *pFileData, uint fileSize,
GraphicEngine::COLOR_FORMATS &colorFormat,
int &width, int &height) {
// Falls die Liste der BS_ImageLoader noch nicht initialisiert wurde, wird dies getan.
if (!_imageLoaderListInitialized)
initializeLoaderList();
// Passenden BS_ImageLoader finden und Bildeigenschaften auslesen.
// Find a suitable ImageLoader and extra the image properties
ImageLoader *pLoader = findSuitableImageLoader(pFileData, fileSize);
if (pLoader) {
return pLoader->imageProperties(pFileData, fileSize,
@ -83,36 +78,29 @@ bool ImageLoader::extractImageProperties(const byte *pFileData, uint fileSize,
return false;
}
void ImageLoader::initializeLoaderList() {
// Von jedem BS_ImageLoader wird eine Instanz erzeugt, diese fügen sich selbständig in die BS_ImageLoader-Liste ein.
for (int i = 0; i < BS_IMAGELOADER_COUNT; i++)
BS_IMAGELOADER_IDS[i]();
// Die Liste als gefüllt markieren.
_imageLoaderListInitialized = true;
// Sicherstellen, dass beim Beenden alle BS_ImageLoader Instanzen zerstört werden.
atexit(ImageLoader::deinitializeLoaderList);
ImageLoaderManager::ImageLoaderManager() {
_imageLoaderList.push_back(new PNGLoader());
_imageLoaderList.push_back(new B25SLoader());
}
void ImageLoader::deinitializeLoaderList() {
ImageLoaderManager::~ImageLoaderManager() {
while (!_imageLoaderList.empty()) {
delete _imageLoaderList.back();
_imageLoaderList.pop_back();
}
}
ImageLoader *ImageLoader::findSuitableImageLoader(const byte *pFileData, uint fileSize) {
// Alle BS_ImageLoader-Objekte durchgehen, bis eins gefunden wurde, dass das Bild laden kann
ImageLoader *ImageLoaderManager::findSuitableImageLoader(const byte *pFileData, uint fileSize) {
// Iterate over all registered ImageLoader instances until we find
// one that supports the image.
Common::List<ImageLoader *>::iterator iter = _imageLoaderList.begin();
for (; iter != _imageLoaderList.end(); ++iter) {
// Falls ein geeigneter BS-ImageLoader gefunden wurde, wird er zurückgegeben.
if ((*iter)->isCorrectImageFormat(pFileData, fileSize)) {
return (*iter);
}
}
// Es konnte kein passender BS_ImageLoader gefunden werden.
// No suitable ImageLoader was found :-(
BS_LOG_ERRORLN("Could not find suitable image loader for image data.");
return NULL;
}

View File

@ -42,95 +42,32 @@
#ifndef SWORD25_IMAGELOADER_H
#define SWORD25_IMAGELOADER_H
// Includes
#include "common/singleton.h"
#include "common/list.h"
#include "sword25/kernel/common.h"
#include "sword25/gfx/graphicengine.h"
namespace Sword25 {
/**
@brief Über die statischen Methoden dieser Klasse werden alle unterstützten Bildformate geladen.
Zum Laden von Bildern wird die #LoadImage-Methode benutzt.
Außerdem stellt diese Klasse das Interface da, das alle Klassen implementieren müssen, die Bildformate einlesen.<br>
Zur Unterstützung eines neuen Bildformates muss folgendermaßen vorgegangen werden:
- Erzeugen einer neuen von #ImageLoader abgeleiteten Klasse, die die Methoden #IsCorrectImageFormat und #DecodeImage impelementiert.
- Die Klasse muss eine statische Methode haben, die eine Instanz von ihr erzeugt und einen Pointer darauf zurückgibt.
- Diese Methode muss in der Liste in der Datei imageloader_ids.h eingetragen werden.
- Die Klasse muss JEDES Eingabebild seines Bildformates in die folgenden Farbformate konvertieren können:
- GraphicEngine::CF_ARGB32
- Zum Konvertieren der Bilddaten können die Hilfsmethoden dieser Klasse benutzt werden, die ARGB Bilddaten in alle benötigten
Farbformate konvertieren.
*/
* This interface is implemented by classes for loading various image file formats.
* Adding support for new formats requires subclassing this, and implementing all
* three pure virtual methods. In addition, ImageLoaderManager needs to be taught
* about the new loader class.
*
* Note that an implementation must be able to convert any input to format GraphicEngine::CF_ARGB32
*/
class ImageLoader {
public:
//@{
/** @name Lade Methoden */
/**
@brief Lädt eine Bilddatei.
Diese Methode kann sämtliche unterstütztem Bildformate lesen. Die Methode erkennt selbstständing um welches Dateiformat es sich
bei der vorliegenden Datei handelt.<br>
Bisher wird nur PNG unterstützt.
@param pFileData ein Pointer auf die Bilddaten.
@param FileSize die Größe der Bilddaten in Byte.
@param ColorFormat gibt das gewünschte Farbformat an, in das die Bilddaten konvertiert werden sollen.<br>
Folgende Farbformate werden unterstützt:
- GraphicEngine::CF_ARGB32
@param pUncompressedData nach erfolgreichen Laden zeigt dieser Pointer auf die enpackten und konvertierten Bilddaten.
@param Width gibt nach erfolgreichen Laden die Breite des geladenen Bildes an.
@param Height gibt nach erfolgreichen Laden die Höhe des geladenen Bildes an.
@param Pitch gibt nach erfolgreichen Laden die Länge einer Bildzeile in Byte an.
@return Gibt false zurück, falls das Laden fehlgeschlagen ist.
@remark Die Größe der Ausgabedaten in Bytes kann wie folgt berechnet werden: Pitch * Height.
@remark Es darf nicht vergessen werden, die Ausgabedaten nach erfolgter Benutzung mit delete freizugeben.
*/
static bool loadImage(const byte *pFileData, uint fileSize,
GraphicEngine::COLOR_FORMATS colorFormat,
byte *&pUncompressedData,
int &width, int &height,
int &pitch);
/**
@brief Liest die Bildeigenschaften eines Bildes aus.
@param pFileData ein Pointer auf die Bilddaten.
@param FileSize die Größe des Bilddaten in Byte.
@param ColorFormat enthält nach einem erfolgreichem Aufruf das Farbformat des Bildes.
@param Width enthält nach einem erfolgreichem Aufruf die Breite des Bildes in Pixeln.
@param Height enthält nach einem erfolgreichem Aufruf die Höhe des Bildes in Pixeln.
@return Gibt false zurück, wenn die Bildeigenschaften nicht ausgelesen werden konnten.
@remark Es darf nicht vergessen werden, die Ausgabedaten nach erfolgter Benutzung mit delete freizugeben.
*/
static bool extractImageProperties(const byte *pFileData, uint fileSize,
GraphicEngine::COLOR_FORMATS &colorFormat,
int &width, int &height);
//@}
protected:
friend class ImageLoaderManager;
// Protected Konstruktor, damit Instanzen dieser Klasse nur von ImageLoader-Objekten erstellt werden können
/**
@brief Der Standardkonstruktor.
Dieser Konstruktor registriert alle Instanzen von #ImageLoader-Klassen in einer Liste.<br>
Diese Liste enthält jeweils eine Instanz jedes #ImageLoader und wird benutzt um beliebige Bilddateien einem Loader zuzuordnen.
@remark Dieser Konstruktor ist protected damit nur #ImageLoader-Objekte diese Klasse instanziieren können.
*/
ImageLoader() {
// Klasse registrieren
_imageLoaderList.push_front(this);
}
// Make the default constructor protected to ensure that only the
// ImageLoaderManager can create instances of ImageLoader subclasses.
ImageLoader() {}
virtual ~ImageLoader() {}
//@{
/** @name Abstrakte Methoden */
/**
@brief Gibt an, ob der #ImageLoader ein Bild lesen kann.
@param pFileData ein Pointer auf die kompletten Daten des Bildes.
@ -177,32 +114,87 @@ protected:
GraphicEngine::COLOR_FORMATS &colorFormat,
int &width, int &height) = 0;
};
class ImageLoaderManager : public Common::Singleton<ImageLoaderManager> {
public:
/**
* Create instances of various ImageLoader subclasses and keep them
* in an internal list. These are then later used when loading images
* via this manager.
*
* @note To add support for additional ImageManagers, you need to modify
* this method.
*/
ImageLoaderManager();
/**
* Destroy any ImageLoader subclasses instances kept by this manager.
*/
~ImageLoaderManager();
//@{
/** @name Methods for loading */
/**
@brief Lädt eine Bilddatei.
Diese Methode kann sämtliche unterstütztem Bildformate lesen. Die Methode erkennt selbstständing um welches Dateiformat es sich
bei der vorliegenden Datei handelt.<br>
Bisher wird nur PNG unterstützt.
@param pFileData ein Pointer auf die Bilddaten.
@param FileSize die Größe der Bilddaten in Byte.
@param ColorFormat gibt das gewünschte Farbformat an, in das die Bilddaten konvertiert werden sollen.<br>
Folgende Farbformate werden unterstützt:
- GraphicEngine::CF_ARGB32
@param pUncompressedData nach erfolgreichen Laden zeigt dieser Pointer auf die enpackten und konvertierten Bilddaten.
@param Width gibt nach erfolgreichen Laden die Breite des geladenen Bildes an.
@param Height gibt nach erfolgreichen Laden die Höhe des geladenen Bildes an.
@param Pitch gibt nach erfolgreichen Laden die Länge einer Bildzeile in Byte an.
@return Gibt false zurück, falls das Laden fehlgeschlagen ist.
@remark Die Größe der Ausgabedaten in Bytes kann wie folgt berechnet werden: Pitch * Height.
@remark Es darf nicht vergessen werden, die Ausgabedaten nach erfolgter Benutzung mit delete freizugeben.
*/
bool loadImage(const byte *pFileData, uint fileSize,
GraphicEngine::COLOR_FORMATS colorFormat,
byte *&pUncompressedData,
int &width, int &height,
int &pitch);
/**
@brief Liest die Bildeigenschaften eines Bildes aus.
@param pFileData ein Pointer auf die Bilddaten.
@param FileSize die Größe des Bilddaten in Byte.
@param ColorFormat enthält nach einem erfolgreichem Aufruf das Farbformat des Bildes.
@param Width enthält nach einem erfolgreichem Aufruf die Breite des Bildes in Pixeln.
@param Height enthält nach einem erfolgreichem Aufruf die Höhe des Bildes in Pixeln.
@return Gibt false zurück, wenn die Bildeigenschaften nicht ausgelesen werden konnten.
@remark Es darf nicht vergessen werden, die Ausgabedaten nach erfolgter Benutzung mit delete freizugeben.
*/
bool extractImageProperties(const byte *pFileData, uint fileSize,
GraphicEngine::COLOR_FORMATS &colorFormat,
int &width, int &height);
//@}
private:
/**
@brief Erzeugt je eine Instanz aller ImageLoader Klassen und fügt diese in eine interne Liste ein. Diese werden dann beim
Laden von Bildern benutzt.
@remark Die Klassen müssen in der Datei imageloader_ids.h eingetragen sein, damit sie an dieser Stelle berücksichtigt werden.
*/
static void initializeLoaderList();
* Finds an ImageLoader instances capable of decoding the given
* image data.
* @return pointer to a suitable ImageLoader, or NULL if none has been be found
*/
ImageLoader *findSuitableImageLoader(const byte *pFileData, uint fileSize);
/**
@brief Zerstört alle Instanzen von ImageLoader Klassen, die in dieser Klasse registriert sind.
*/
static void deinitializeLoaderList();
/**
@brief Sucht zu Bilddaten ein ImageLoader Objekt, dass die Bilddaten dekodieren kann.
@return Gibt einen Pointer auf ein passendes ImageLoader Objekt zurück, oder NULL, wenn kein passendes Objekt gefunden wurde.
*/
static ImageLoader *findSuitableImageLoader(const byte *pFileData, uint fileSize);
static Common::List<ImageLoader *> _imageLoaderList; // Die Liste aller ImageLoader-Objekte
static bool _imageLoaderListInitialized; // Gibt an, ob die Liste schon intialisiert wurde
Common::List<ImageLoader *> _imageLoaderList; ///< List of ImageLoader instances
};
/** Shortcut for accessing the image loader manager. */
#define ImageMan ImageLoaderManager::instance()
} // End of namespace Sword25
#endif

View File

@ -1,62 +0,0 @@
/* 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
*
*/
/*
imageloader_ids.h
-----------------
In dieser Datei sind alle ImageLoader verzeichnet.
JEDER neuer ImageLoader muss hier eingetragen werden, ansonsten wird er beim Laden eines Bildes nicht berücksichtigt.
Autor: Malte Thiesen
*/
#include "sword25/gfx/image/imageloader.h"
// Die Headerdateien der ImageLoader müssen hier eingebunden werden
#include "sword25/gfx/image/pngloader.h"
#include "sword25/gfx/image/b25sloader.h"
namespace Sword25 {
// Die Tabelle enthält Pointer auf statische Member-Funktionen innerhalb der Klassen, die eine Instanz der Klasse
// erzeugen
typedef ImageLoader*(*BS_IMAGELOADER_NEW)();
const BS_IMAGELOADER_NEW BS_IMAGELOADER_IDS[] = {
PNGLoader::createInstance,
B25SLoader::createInstance,
};
const int BS_IMAGELOADER_COUNT = sizeof(BS_IMAGELOADER_IDS) / sizeof(BS_IMAGELOADER_NEW);
} // End of namespace Sword25

View File

@ -51,11 +51,8 @@ namespace Sword25 {
// Klassendefinition
class PNGLoader : public ImageLoader {
friend class ImageLoaderManager;
public:
static ImageLoader *createInstance() {
return (ImageLoader *) new PNGLoader();
}
// Alle virtuellen Methoden von BS_ImageLoader sind hier als static-Methode implementiert, damit sie von BS_B25SLoader aufgerufen werden können.
// Die virtuellen Methoden rufen diese Methoden auf.
static bool doIsCorrectImageFormat(const byte *fileDataPtr, uint fileSize);

View File

@ -72,14 +72,14 @@ RenderedImage::RenderedImage(const Common::String &filename, bool &result) :
// Bildeigenschaften bestimmen
GraphicEngine::COLOR_FORMATS colorFormat;
int pitch;
if (!ImageLoader::extractImageProperties(pFileData, fileSize, colorFormat, _width, _height)) {
if (!ImageMan.extractImageProperties(pFileData, fileSize, colorFormat, _width, _height)) {
BS_LOG_ERRORLN("Could not read image properties.");
delete[] pFileData;
return;
}
// Das Bild dekomprimieren
if (!ImageLoader::loadImage(pFileData, fileSize, GraphicEngine::CF_ARGB32, _data, _width, _height, pitch)) {
if (!ImageMan.loadImage(pFileData, fileSize, GraphicEngine::CF_ARGB32, _data, _width, _height, pitch)) {
BS_LOG_ERRORLN("Could not decode image.");
delete[] pFileData;
return;

View File

@ -61,14 +61,14 @@ SWImage::SWImage(const Common::String &filename, bool &result) :
// Bildeigenschaften bestimmen
GraphicEngine::COLOR_FORMATS colorFormat;
int pitch;
if (!ImageLoader::extractImageProperties(pFileData, fileSize, colorFormat, _width, _height)) {
if (!ImageMan.extractImageProperties(pFileData, fileSize, colorFormat, _width, _height)) {
BS_LOG_ERRORLN("Could not read image properties.");
return;
}
// Das Bild dekomprimieren
byte *pUncompressedData;
if (!ImageLoader::loadImage(pFileData, fileSize, GraphicEngine::CF_ARGB32, pUncompressedData, _width, _height, pitch)) {
if (!ImageMan.loadImage(pFileData, fileSize, GraphicEngine::CF_ARGB32, pUncompressedData, _width, _height, pitch)) {
BS_LOG_ERRORLN("Could not decode image.");
return;
}

View File

@ -45,6 +45,7 @@
#include "sword25/gfx/animationtemplateregistry.h" // Needed so we can destroy the singleton
#include "sword25/gfx/renderobjectregistry.h" // Needed so we can destroy the singleton
#include "sword25/math/regionregistry.h" // Needed so we can destroy the singleton
#include "sword25/gfx/image/imageloader.h" // Needed so we can destroy the singleton
namespace Sword25 {
@ -137,6 +138,7 @@ bool Sword25Engine::appEnd() {
// The kernel is shutdown, and un-initialises all subsystems
Kernel::deleteInstance();
ImageLoaderManager::destroy();
AnimationTemplateRegistry::destroy();
RenderObjectRegistry::destroy();
RegionRegistry::destroy();