scummvm/queen/resource.h

/* ScummVM - Scumm Interpreter
 * Copyright (C) 2003-2005 The ScummVM project
 *
 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * $Header$
 *
 */

#ifndef QUEENRESOURCE_H
#define QUEENRESOURCE_H

#include "common/file.h"
#include "common/util.h"
#include "queen/defs.h"

namespace Queen {

struct ResourceEntry {
	char filename[13];
	uint8 bundle;
	uint32 offset;
	uint32 size;
};

struct GameVersion {
	char versionString[6];
	uint32 tableOffset;
	uint32 dataFileSize;
};

class LineReader {
public:

	LineReader(char *buffer, uint32 bufsize);
	~LineReader();
	char *nextLine();

private:

	char *_buffer;
	uint32 _bufSize;
	int _current;
};

class Resource {
public:

	Resource();
	~Resource();

	//! loads the specified from the resource file
	uint8 *loadFile(const char *filename, uint32 skipBytes = 0, uint32 *size = NULL, bool useMalloc = false);
	
	//! returns true if the file is present in the resource
	bool fileExists(const char *filename) const { return resourceEntry(filename) != NULL; }

	//! returns a reference to a sound file
	File *giveCompressedSound(const char *filename, uint32 *size);

	bool isDemo() const { return !strcmp(_versionString, "PE100"); }
	bool isInterview() const { return !strcmp(_versionString, "PEint"); }
	bool isFloppy() const { return _versionString[0] == 'P'; }
	bool isCD() const { return _versionString[0] == 'C'; }
	
	//! returns compression type for audio files
	uint8 compression() const { return _compression; }
	
	//! returns JAS version string (contains language, platform and version information)
	const char *JASVersion() const { return _versionString; }
	
	//! returns language of the game
	Language getLanguage() const;

	enum Version {
		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_COUNT        = 13
	};
	
	enum {
		CURRENT_TBL_VERSION = 1
	}; 

	enum {
		JAS_VERSION_OFFSET_DEMO = 0x119A8,
		JAS_VERSION_OFFSET_INTV	= 0xCF8,
		JAS_VERSION_OFFSET_PC	= 0x12484
	};

protected:

	File *_resourceFile;
	
	//! compression type for audio files
	uint8 _compression;
	
	//! JAS version string of the game
	char _versionString[6];
	
	//! number of entries in resource table
	uint32 _resourceEntries;
	
	ResourceEntry *_resourceTable;

	//! look for a normal queen version (ie. queen.1)
	bool findNormalVersion();
	
	//! look for a compressed/rebuilt queen version (ie. queen.1c)
	bool findCompressedVersion();
	
	//! verify the version of the selected game
	void checkJASVersion();
	
	//! returns a reference to the ReseourceEntry for the specified filename
	ResourceEntry *resourceEntry(const char *filename) const;
	
	//! extarct the resource table for the specified game version
	bool readTableFile(const GameVersion *gameVersion);
	
	//! reads the resource table from a rebuilt datafile (ie. queen.1c)
	void readTableCompResource();
	
	//! read the resource table from the specified file
	void readTableEntries(File *file);
	
	//! detect game version based on queen.1 datafile size
	const GameVersion *detectGameVersion(uint32 size) const;

	//! resource table filename (queen.tbl)
	static const char *_tableFilename;
	
	//! known FOTAQ versions
	static const GameVersion _gameVersions[];
	
#ifndef __PALM_OS__
	//! resource table for english floppy version
	static ResourceEntry _resourceTablePEM10[];
#endif
};

} // End of namespace Queen

#endif