2007-05-30 21:56:52 +00:00
|
|
|
/* 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.
|
2003-09-28 15:50:47 +00:00
|
|
|
*
|
|
|
|
* 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
|
2008-01-05 12:45:14 +00:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
2003-09-28 15:50:47 +00:00
|
|
|
* 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
|
2005-10-18 01:30:26 +00:00
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2003-09-28 15:50:47 +00:00
|
|
|
*
|
2006-02-11 10:07:12 +00:00
|
|
|
* $URL$
|
|
|
|
* $Id$
|
2003-09-28 15:50:47 +00:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2006-11-12 17:47:16 +00:00
|
|
|
#ifndef QUEEN_RESOURCE_H
|
|
|
|
#define QUEEN_RESOURCE_H
|
2003-09-28 15:50:47 +00:00
|
|
|
|
|
|
|
#include "common/file.h"
|
2010-03-18 15:09:24 +00:00
|
|
|
#include "common/str-array.h"
|
2003-12-01 20:48:41 +00:00
|
|
|
#include "common/util.h"
|
|
|
|
#include "queen/defs.h"
|
2003-09-28 15:50:47 +00:00
|
|
|
|
2003-10-03 19:47:41 +00:00
|
|
|
namespace Queen {
|
|
|
|
|
2006-11-04 12:00:31 +00:00
|
|
|
enum GameFeatures {
|
|
|
|
GF_DEMO = 1 << 0, // demo
|
|
|
|
GF_TALKIE = 1 << 1, // equivalent to cdrom version check
|
|
|
|
GF_FLOPPY = 1 << 2, // floppy, ie. non-talkie version
|
|
|
|
GF_INTERVIEW = 1 << 3, // interview demo
|
|
|
|
GF_REBUILT = 1 << 4 // version rebuilt with the 'compression_queen' tool
|
2003-09-28 15:50:47 +00:00
|
|
|
};
|
|
|
|
|
2006-11-04 12:00:31 +00:00
|
|
|
struct RetailGameVersion {
|
|
|
|
char str[6];
|
2007-03-02 23:57:37 +00:00
|
|
|
uint8 queenTblVersion;
|
|
|
|
uint32 queenTblOffset;
|
2003-10-30 23:20:47 +00:00
|
|
|
uint32 dataFileSize;
|
2003-09-28 15:50:47 +00:00
|
|
|
};
|
|
|
|
|
2006-11-04 12:00:31 +00:00
|
|
|
struct DetectedGameVersion {
|
2007-02-21 20:27:48 +00:00
|
|
|
Common::Platform platform;
|
2006-11-04 12:00:31 +00:00
|
|
|
Common::Language language;
|
|
|
|
uint8 features;
|
|
|
|
uint8 compression;
|
|
|
|
char str[6];
|
2007-03-02 23:57:37 +00:00
|
|
|
uint8 queenTblVersion;
|
|
|
|
uint32 queenTblOffset;
|
2006-11-04 12:00:31 +00:00
|
|
|
};
|
2004-12-31 00:25:18 +00:00
|
|
|
|
2006-11-04 12:00:31 +00:00
|
|
|
struct ResourceEntry {
|
|
|
|
char filename[13];
|
|
|
|
uint8 bundle;
|
|
|
|
uint32 offset;
|
|
|
|
uint32 size;
|
2004-01-05 11:58:20 +00:00
|
|
|
};
|
2003-09-29 22:27:08 +00:00
|
|
|
|
2003-10-05 16:07:07 +00:00
|
|
|
class Resource {
|
2003-09-28 15:50:47 +00:00
|
|
|
public:
|
2004-12-31 00:25:18 +00:00
|
|
|
|
2004-08-06 17:01:58 +00:00
|
|
|
Resource();
|
|
|
|
~Resource();
|
2003-12-28 15:29:05 +00:00
|
|
|
|
2007-02-25 22:24:11 +00:00
|
|
|
//! loads a binary file
|
2006-11-24 18:24:45 +00:00
|
|
|
uint8 *loadFile(const char *filename, uint32 skipBytes = 0, uint32 *size = NULL);
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2007-02-25 22:24:11 +00:00
|
|
|
//! loads a text file
|
2010-03-18 15:09:24 +00:00
|
|
|
void loadTextFile(const char *filename, Common::StringArray &stringList);
|
2007-02-25 22:24:11 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
//! returns true if the file is present in the resource
|
2003-12-29 13:18:24 +00:00
|
|
|
bool fileExists(const char *filename) const { return resourceEntry(filename) != NULL; }
|
2003-12-28 15:29:05 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
//! returns a reference to a sound file
|
2007-02-20 19:23:07 +00:00
|
|
|
Common::File *findSound(const char *filename, uint32 *size);
|
2003-12-28 15:29:05 +00:00
|
|
|
|
2006-11-12 17:47:16 +00:00
|
|
|
bool isDemo() const { return (_version.features & GF_DEMO) != 0; }
|
|
|
|
bool isInterview() const { return (_version.features & GF_INTERVIEW) != 0; }
|
|
|
|
bool isFloppy() const { return (_version.features & GF_FLOPPY) != 0; }
|
|
|
|
bool isCD() const { return (_version.features & GF_TALKIE) != 0; }
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
//! returns compression type for audio files
|
2006-11-04 12:00:31 +00:00
|
|
|
uint8 getCompression() const { return _version.compression; }
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
//! returns JAS version string (contains language, platform and version information)
|
2006-11-04 12:00:31 +00:00
|
|
|
const char *getJASVersion() const { return _version.str; }
|
|
|
|
|
|
|
|
//! returns the language of the game
|
|
|
|
Common::Language getLanguage() const { return _version.language; }
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2007-02-21 20:27:48 +00:00
|
|
|
Common::Platform getPlatform() const { return _version.platform; }
|
|
|
|
|
2006-11-04 12:00:31 +00:00
|
|
|
//! detect game version
|
|
|
|
static bool detectVersion(DetectedGameVersion *ver, Common::File *f);
|
2003-12-28 15:29:05 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
enum Version {
|
2007-02-21 20:27:48 +00:00
|
|
|
VER_ENG_FLOPPY = 0,
|
|
|
|
VER_ENG_TALKIE = 1,
|
|
|
|
VER_FRE_FLOPPY = 2,
|
|
|
|
VER_FRE_TALKIE = 3,
|
|
|
|
VER_GER_FLOPPY = 4,
|
|
|
|
VER_GER_TALKIE = 5,
|
|
|
|
VER_ITA_FLOPPY = 6,
|
|
|
|
VER_ITA_TALKIE = 7,
|
|
|
|
VER_SPA_TALKIE = 8,
|
|
|
|
VER_HEB_TALKIE = 9,
|
|
|
|
VER_DEMO_PCGAMES = 10,
|
|
|
|
VER_DEMO = 11,
|
|
|
|
VER_INTERVIEW = 12,
|
|
|
|
VER_AMI_ENG_FLOPPY = 13,
|
|
|
|
VER_AMI_DEMO = 14,
|
|
|
|
VER_AMI_INTERVIEW = 15,
|
|
|
|
|
|
|
|
VER_COUNT = 16
|
2004-12-31 00:25:18 +00:00
|
|
|
};
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2003-12-11 21:04:02 +00:00
|
|
|
enum {
|
2003-12-26 15:36:28 +00:00
|
|
|
JAS_VERSION_OFFSET_DEMO = 0x119A8,
|
2004-02-11 21:07:39 +00:00
|
|
|
JAS_VERSION_OFFSET_INTV = 0xCF8,
|
2004-12-31 00:25:18 +00:00
|
|
|
JAS_VERSION_OFFSET_PC = 0x12484
|
2003-12-11 21:04:02 +00:00
|
|
|
};
|
2003-09-28 15:50:47 +00:00
|
|
|
|
|
|
|
protected:
|
2004-12-31 00:25:18 +00:00
|
|
|
|
2006-11-04 12:00:31 +00:00
|
|
|
Common::File _resourceFile;
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2007-02-22 12:12:45 +00:00
|
|
|
int _currentResourceFileNum;
|
|
|
|
|
2006-11-04 12:00:31 +00:00
|
|
|
DetectedGameVersion _version;
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
//! number of entries in resource table
|
2003-10-06 23:04:00 +00:00
|
|
|
uint32 _resourceEntries;
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2003-10-06 23:04:00 +00:00
|
|
|
ResourceEntry *_resourceTable;
|
2003-12-28 15:29:05 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
//! verify the version of the selected game
|
2003-12-28 15:29:05 +00:00
|
|
|
void checkJASVersion();
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
//! returns a reference to the ReseourceEntry for the specified filename
|
2003-12-29 13:18:24 +00:00
|
|
|
ResourceEntry *resourceEntry(const char *filename) const;
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2007-02-22 12:12:45 +00:00
|
|
|
//! seeks resource file to specific bundle and file offset
|
|
|
|
void seekResourceFile(int num, uint32 offset);
|
|
|
|
|
2007-03-02 23:57:37 +00:00
|
|
|
//! extract the resource table for the specified game version
|
|
|
|
void readTableFile(uint8 version, uint32 offset);
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
//! read the resource table from the specified file
|
2005-05-10 22:56:25 +00:00
|
|
|
void readTableEntries(Common::File *file);
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
//! detect game version based on queen.1 datafile size
|
2006-11-04 12:00:31 +00:00
|
|
|
static const RetailGameVersion *detectGameVersionFromSize(uint32 size);
|
2003-12-11 21:04:02 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
//! resource table filename (queen.tbl)
|
2003-12-11 21:04:02 +00:00
|
|
|
static const char *_tableFilename;
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
//! known FOTAQ versions
|
2006-11-04 12:00:31 +00:00
|
|
|
static const RetailGameVersion _gameVersions[];
|
2005-07-30 21:11:48 +00:00
|
|
|
|
2004-12-31 00:25:18 +00:00
|
|
|
//! resource table for english floppy version
|
2003-10-06 23:04:00 +00:00
|
|
|
static ResourceEntry _resourceTablePEM10[];
|
2003-09-28 15:50:47 +00:00
|
|
|
};
|
|
|
|
|
2003-10-03 19:47:41 +00:00
|
|
|
} // End of namespace Queen
|
|
|
|
|
2003-09-28 15:50:47 +00:00
|
|
|
#endif
|