Ticket #9023: draci2.patch

configure

@@ -96 +96 @@
 add_engine tinsel "Tinsel" no
 add_engine touche "Touche: The Adventures of the Fifth Musketeer" yes
 add_engine tucker "Bud Tucker in Double Trouble" yes
+add_engine draci "Dragon History" no
 
 
 #

engines/draci/detection.cpp

@@ +1 @@
+/* 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$
+ *
+ */
+
+#include "draci/draci.h"
+
+#include "base/plugins.h"
+#include "engines/metaengine.h"
+
+static const PlainGameDescriptor draciGames[] = {
+        { "draci", "Draci Historie" },
+        { 0, 0 }
+};
+
+namespace Draci {
+
+const ADGameDescription gameDescriptions[] = {
+        
+        {
+                "draci",
+                0,
+                AD_ENTRY1s("INIT.DFW", "b890a5aeebaf16af39219cba2416b0a3", 906),
+                Common::EN_ANY,
+                Common::kPlatformPC,
+                ADGF_NO_FLAGS
+        },
+        
+        {
+                "draci",
+                0,
+                AD_ENTRY1s("INIT.DFW", "9921c8f0045679a8f37eca8d41c5ec02", 906),
+                Common::CZ_CZE,
+                Common::kPlatformPC,
+                ADGF_NO_FLAGS
+        },
+
+        {
+                "draci",
+                0,
+                AD_ENTRY1s("INIT.DFW", "76b9b78a8a8809a240acc395df4d0715", 906),
+                Common::PL_POL,
+                Common::kPlatformPC,
+                ADGF_NO_FLAGS
+        },
+
+        AD_TABLE_END_MARKER
+};
+
+} // End of namespace Draci
+
+const ADParams detectionParams = {
+        // Pointer to ADGameDescription or its superset structure
+        (const byte *)Draci::gameDescriptions,
+        // Size of that superset structure
+        sizeof(ADGameDescription),
+        // Number of bytes to compute MD5 sum for
+        5000,
+        // List of all engine targets
+        draciGames,
+        // Structure for autoupgrading obsolete targets
+        0,
+        // Name of single gameid (optional)
+        "draci",
+        // List of files for file-based fallback detection (optional)
+        0,
+        // Flags
+        0
+};
+
+class DraciMetaEngine : public AdvancedMetaEngine {
+public:
+        DraciMetaEngine() : AdvancedMetaEngine(detectionParams) {}
+        
+        virtual const char *getName() const {
+                return "Draci Historie Engine";
+        }
+
+        virtual const char *getOriginalCopyright() const {
+                return "Copyright (C) 1995 NoSense";
+        }
+        
+        virtual bool hasFeature(MetaEngineFeature f) const;
+        virtual bool createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const;
+};
+
+bool DraciMetaEngine::hasFeature(MetaEngineFeature f) const {
+        return false;
+}
+
+bool Draci::DraciEngine::hasFeature(EngineFeature f) const {
+        return false;
+}
+
+bool DraciMetaEngine::createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const {
+        if (desc) {
+                *engine = new Draci::DraciEngine(syst, Draci::gameDescriptions);
+        }
+        return desc != 0;
+}
+
+#if PLUGIN_ENABLED_DYNAMIC(DRACI)
+        REGISTER_PLUGIN_DYNAMIC(DRACI, PLUGIN_TYPE_ENGINE, DraciMetaEngine);
+#else
+        REGISTER_PLUGIN_STATIC(DRACI, PLUGIN_TYPE_ENGINE, DraciMetaEngine);
+#endif

engines/draci/draci.cpp

@@ +1 @@
+/* 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$
+ *
+ */
+
+ 
+#include "common/scummsys.h"
+ 
+#include "common/config-manager.h"
+#include "common/events.h"
+#include "common/file.h"
+ 
+#include "draci/draci.h"
+
+#include "draci/barchive.h"
+
+namespace Draci {
+
+DraciEngine::DraciEngine(OSystem *syst, const ADGameDescription *gameDesc) 
+ : Engine(syst) {
+        // Put your engine in a sane state, but do nothing big yet;
+        // in particular, do not load data from files; rather, if you
+        // need to do such things, do them from init().
+ 
+        // Do not initialize graphics here
+ 
+        // However this is the place to specify all default directories
+        //Common::File::addDefaultDirectory(_gameDataPath + "sound/");
+ 
+        // Here is the right place to set up the engine specific debug levels
+        Common::addDebugChannel(kDraciGeneralDebugLevel, "general", "Draci general debug level");
+ 
+        // Don't forget to register your random source
+        syst->getEventManager()->registerRandomSource(_rnd, "draci");
+}
+
+int DraciEngine::init() {
+        // Initialize graphics using following:
+        initGraphics(320, 200, false);
+
+        // Basic archive test
+        Common::String path("INIT.DFW");        
+        BArchive ar(path);
+        BAFile *f;
+        f = ar[0];
+        debugN(0, "First 10 bytes of file %d: ", 0);
+        for(unsigned int i = 0; i < 10; ++i) {
+                debugN(0, "0x%02x%c", f->_data[i], (i < 9) ? ' ' : '\n');
+        }
+
+        Common::String path2("IKONY.DFW");      
+        ar.closeArchive();
+        ar.openArchive(path2);
+        f = ar[0];
+        debugN(0, "First 10 bytes of file %d: ", 0);
+        for(unsigned int i = 0; i < 10; ++i) {
+                debugN(0, "0x%02x%c", f->_data[i], (i < 9) ? ' ' : '\n');
+        }
+
+        return 0;
+}
+
+int DraciEngine::go() {
+        debugC(1, kDraciGeneralDebugLevel, "DraciEngine::go()");
+ 
+        return 0;
+}
+
+DraciEngine::~DraciEngine() {
+        // Dispose your resources here
+ 
+        // Remove all of our debug levels here
+        Common::clearAllDebugChannels();
+}
+
+Common::Error DraciEngine::run() {
+        init();
+        go();
+        return Common::kNoError;
+}
+
+} // End of namespace Draci

engines/draci/barchive.cpp

@@ +1 @@
+/* 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$
+ *
+ */
+
+#include "common/debug.h"
+#include "common/file.h"
+#include "common/str.h"
+#include "common/stream.h"
+
+#include "draci/barchive.h"
+#include "draci/draci.h"
+
+namespace Draci {
+
+const char BArchive::_magicNumber[] = "BAR!";
+
+/**
+ * @brief BArchive open method
+ * @param path Path to input file
+ *
+ * Opens a BAR (Bob's Archiver) archive, which is the game's archiving format.
+ * BAR archives have a .DFW file extension, due to an unused historical interface.
+ * 
+ * archive format: header, 
+ *                 file0, file1, ...
+ *                 footer
+ * header format: [4 bytes] magic number "BAR!"
+ *                [uint16LE] file count (number of archived streams),
+ *                [uint32LE] footer offset from start of file
+ * file<N> format: [2 bytes] compressed length
+ *                 [2 bytes] original length
+ *                 [1 byte] compression type
+ *                 [1 byte] CRC
+ * footer format: [array of uint32LE] offsets of individual files from start of archive 
+ *                (last entry is footer offset again)
+ */
+
+void BArchive::openArchive(const Common::String &path) {
+        byte buf[4];
+        byte *footer;
+        uint32 footerOffset, footerSize;
+        Common::File f;
+
+        // Close previously opened archive (if any)
+        closeArchive();
+        
+        debugC(5, kDraciGeneralDebugLevel, "Loading BAR archive %s:", 
+                path.c_str());
+
+        f.open(path);
+        if (f.isOpen()) {
+                debugC(5, kDraciGeneralDebugLevel, "Success");
+        } else {
+                debugC(5, kDraciGeneralDebugLevel, "Error");
+                return;
+        }
+
+        // Save path for reading in files later on
+        _path = path;
+
+        // Read archive header
+        debugC(5, kDraciGeneralDebugLevel, "Checking magic number:");
+
+        f.read(buf, 4);
+        if (memcmp(buf, _magicNumber, 4) == 0) {
+                debugC(5, kDraciGeneralDebugLevel, "Success");
+        } else {
+                debugC(5, kDraciGeneralDebugLevel, "Error");
+                f.close();
+                return;
+        }
+
+        _fileCount = f.readUint16LE();
+        footerOffset = f.readUint32LE();
+        footerSize = f.size() - footerOffset;
+        
+        debugC(5, kDraciGeneralDebugLevel, "Archive info: %d files, %d data bytes",
+                _fileCount, footerOffset - _archiveHeaderSize);
+
+        // Read in footer       
+        footer = new byte[footerSize];  
+        f.seek(footerOffset);
+        f.read(footer, footerSize);
+        Common::MemoryReadStream reader(footer, footerSize);
+
+        // Read in file headers, but do not read the actual data yet
+        // The data will be read on demand to save memory
+        _files = new BAFile[_fileCount];
+
+        for (unsigned int i = 0; i < _fileCount; i++) {
+                uint32 fileOffset;                      
+                
+                fileOffset = reader.readUint32LE();
+                f.seek(fileOffset); // Seek to next file in archive
+                f.readUint16LE(); // Compressed size, not used
+                _files[i]._length = f.readUint16LE(); // Original size
+                _files[i]._offset = fileOffset;
+
+                assert(f.readByte() == 0 && 
+                        "Compression type flag is non-zero (file is compressed)");
+
+                _files[i]._crc = f.readByte(); // CRC checksum of the file
+                _files[i]._data = NULL; // File data will be read in on demand
+        }       
+        
+        // Last footer item should be equal to footerOffset
+        assert(reader.readUint32LE() == footerOffset && "Footer offset mismatch");
+        
+        f.close();
+}
+
+/**
+ * @brief BArchive close method
+ *
+ * Closes the currently opened archive. It can be called explicitly to
+ * free up memory.
+ */
+void BArchive::closeArchive(void) {
+        if (!_files) {
+                return;
+        }
+
+        for (unsigned int i = 0; i < _fileCount; ++i) {
+                if (_files[i]._data) {
+                        delete _files[i]._data; 
+                }
+        }
+
+        delete[] _files;
+
+        _files = NULL;
+        _fileCount = 0;
+}
+
+BAFile *BArchive::operator[](unsigned int i) const {
+        Common::File f;
+
+        // Check whether requested file exists
+        if (i >= _fileCount) {
+                return NULL;
+        }
+
+        debugC(5, kDraciGeneralDebugLevel, "Accessing file %d from archive %s", 
+                i, _path.c_str());
+
+        // Check if file has already been opened and return that
+        if (_files[i]._data) {
+                return _files + i;
+        }
+        
+        // Else open archive and read in requested file
+        f.open(_path);
+        if (f.isOpen()) {
+                debugC(5, kDraciGeneralDebugLevel, "Success");
+        } else {
+                debugC(5, kDraciGeneralDebugLevel, "Error");
+                return NULL;
+        }
+
+        // Read in the file (without the file header)
+        f.seek(_files[i]._offset + _fileHeaderSize);
+        _files[i]._data = new byte[_files[i]._length];
+        f.read(_files[i]._data, _files[i]._length);
+
+        // Calculate CRC
+        byte tmp = 0;
+        for (unsigned int j = 0; j < _files[i]._length; j++) {
+                tmp ^= _files[i]._data[j];
+        }
+        
+        assert(tmp == _files[i]._crc && "CRC checksum mismatch");
+
+        return _files + i;
+}
+
+} // End of namespace Draci
+
+
+

engines/draci/draci.h

@@ +1 @@
+/* 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$
+ *
+ */
+
+#ifndef DRACI_H
+#define DRACI_H
+ 
+#include "common/system.h"
+#include "engines/engine.h"
+#include "engines/advancedDetector.h"
+
+namespace Draci {
+
+class DraciEngine : public Engine {
+public:
+        DraciEngine(OSystem *syst, const ADGameDescription *gameDesc);
+        ~DraciEngine();
+
+        int init();
+        int go();
+        Common::Error run();
+
+        bool hasFeature(Engine::EngineFeature f) const;
+
+private:
+        Common::RandomSource _rnd;
+};
+
+enum {
+        kDraciGeneralDebugLevel = 1 << 0
+};
+
+} // End of namespace Draci
+
+#endif // DRACI_H
+

engines/draci/barchive.h

@@ +1 @@
+/* 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$
+ *
+ */
+
+#ifndef BARCHIVE_H
+#define BARCHIVE_H
+
+#include "common/str.h"
+
+namespace Draci {
+
+/**
+ *  Represents individual files inside the archive
+ */
+
+struct BAFile {
+        uint16 _length;
+        uint32 _offset; //!< Offset of file inside archive      
+        byte *_data;
+        byte _crc;
+
+        void closeFile(void) { //!< Releases the file data (for memory considerations)
+                delete _data;
+                _data = NULL;
+        }
+};
+
+class BArchive {
+public:
+        BArchive() : _files(NULL), _fileCount(0) {}
+        BArchive(Common::String &path) : _files(NULL), _fileCount(0) { openArchive(path); }
+        ~BArchive() { closeArchive(); }
+
+        void openArchive(const Common::String &path);
+        void closeArchive(void);
+        uint16 size() const { return _fileCount; }
+
+        BAFile *operator[](unsigned int i) const;
+
+private:
+        // Archive header data
+        static const char _magicNumber[];
+        static const unsigned int _archiveHeaderSize = 10;
+        
+        // File stream header data
+        static const unsigned int _fileHeaderSize = 6;
+
+        Common::String _path;    //!< Path to file
+        BAFile *_files;          //!< Internal array of files
+        uint16 _fileCount;       //!< Number of files in archive
+};
+
+} // End of namespace Draci
+
+#endif // BARCHIVE_H

engines/draci/module.mk

@@ +1 @@
+MODULE := engines/draci
+ 
+MODULE_OBJS := \
+        draci.o \
+        detection.o \
+        barchive.o
+ 
+MODULE_DIRS += \
+        engines/draci
+ 
+# This module can be built as a plugin
+ifeq ($(ENABLE_DRACI), DYNAMIC_PLUGIN)
+PLUGIN := 1
+endif
+ 
+# Include common rules 
+include $(srcdir)/rules.mk

engines/engines.mk

@@ -36 +36 @@
 MODULES += engines/cruise
 endif
 
+ifdef ENABLE_DRACI
+DEFINES += -DENABLE_DRACI=$(ENABLE_DRACI)
+MODULES += engines/draci
+endif
+
 ifdef ENABLE_DRASCULA
 DEFINES += -DENABLE_DRASCULA=$(ENABLE_DRASCULA)
 MODULES += engines/drascula

base/plugins.cpp

@@ -157 +157 @@
                 #if PLUGIN_ENABLED_STATIC(TUCKER)
                 LINK_PLUGIN(TUCKER)
                 #endif
+                #if PLUGIN_ENABLED_STATIC(DRACI)
+                LINK_PLUGIN(DRACI)
+                #endif
 
                 // Music plugins
                 // TODO: Use defines to disable or enable each MIDI driver as a