/* 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef DIRECTOR_ARCHIVE_H
#define DIRECTOR_ARCHIVE_H

#include "common/hash-str.h"
#include "common/file.h"

namespace Common {
class MacResManager;
class SeekableMemoryWriteStream;
class SeekableReadStreamEndian;
class SeekableReadStream;
class Path;
}

namespace Director {

// Completely ripped off of Mohawk's Archive code

struct Resource {
	uint32 index;
	int32 offset;
	uint32 size;
	uint32 uncompSize;
	uint32 compressionType;
	uint32 castId;
	uint32 libResourceId;
	uint32 tag;
	uint16 flags;
	uint16 unk1;
	uint32 nextFreeResourceID;
	Common::String name;
	Common::Array<Resource> children;
	bool accessed;

	Resource() = default;
	Resource(Resource *original) {
		index = original->index;
		offset = original->offset;
		size = original->size;
		uncompSize = original->uncompSize;
		compressionType = original->compressionType;
		castId = original->castId;
		libResourceId = original->libResourceId;
		tag = original->tag;
		flags = original->flags;
		unk1 = original->unk1;
		nextFreeResourceID = original->nextFreeResourceID;
		name = Common::String(original->name);
		children = Common::Array<Resource>(original->children);
		accessed = original->accessed;
	}
};

class Archive {
public:
	Archive();
	virtual ~Archive();

	virtual bool openFile(const Common::Path &path);
	virtual bool openStream(Common::SeekableReadStream *stream, uint32 offset = 0) = 0;
	virtual bool writeToFile(Common::String filename, Movie *movie) {
		// Saving Director movies was introduced in Director 4
		// However, from DirectorEngine::createArchive, it is evident that after Director 4 only RIFX Archives were written
		error("Archive::writeToFile was called on a non-RIFX Archive, which is not allowed");
		return false;
	}
	virtual void close();

	/* Loading Functions for Cast */
	bool loadConfig(Cast *cast);

	Common::Path getPathName() const { return _pathName; }
	Common::String getFileName() const;
	void setPathName(const Common::Path &name) { _pathName = name; }
	virtual uint32 getFileSize();

	bool isOpen() const { return _stream != 0; }

	bool hasResource(uint32 tag, int id) const;
	bool hasResource(uint32 tag, const Common::String &resName) const;
	virtual Common::SeekableReadStreamEndian *getResource(uint32 tag, uint16 id);
	virtual Common::SeekableReadStreamEndian *getFirstResource(uint32 tag);
	virtual Common::SeekableReadStreamEndian *getFirstResource(uint32 tag, uint16 parentId);
	virtual Resource getResourceDetail(uint32 tag, uint16 id);
	uint32 getOffset(uint32 tag, uint16 id) const;
	uint getResourceSize(uint32 tag, uint16 id) const;
	uint16 findResourceID(uint32 tag, const Common::String &resName, bool ignoreCase = false) const;
	Common::String getName(uint32 tag, uint16 id) const;
	Common::SeekableReadStreamEndian *getMovieResourceIfPresent(uint32 tag);

	Common::Array<uint32> getResourceTypeList() const;
	Common::Array<uint16> getResourceIDList(uint32 type) const;
	bool _isBigEndian;
	static uint32 convertTagToUppercase(uint32 tag);

	virtual Common::String formatArchiveInfo();

	void listUnaccessedChunks();

protected:
	void dumpChunk(Resource &res, Common::DumpFile &out);
	Common::SeekableReadStream *_stream;
	typedef Common::HashMap<uint16, Resource> ResourceMap;
	typedef Common::HashMap<uint32, ResourceMap> TypeMap;
	typedef Common::HashMap<uint32, uint32> MovieChunkMap;
	TypeMap _types;
	MovieChunkMap _movieChunks;

	Common::Path _pathName;
};

class MacArchive : public Archive {
public:
	MacArchive();
	~MacArchive() override;

	uint32 getFileSize() override;
	void close() override;
	bool openFile(const Common::Path &path) override;
	bool openStream(Common::SeekableReadStream *stream, uint32 startOffset = 0) override;
	Common::SeekableReadStreamEndian *getResource(uint32 tag, uint16 id) override;
	Common::String formatArchiveInfo() override;

private:
	Common::MacResManager *_resFork;

	void readTags();
};

class RIFFArchive : public Archive {
public:
	RIFFArchive() : Archive() { _startOffset = 0; }
	~RIFFArchive() override {}

	bool openStream(Common::SeekableReadStream *stream, uint32 startOffset = 0) override;
	Common::SeekableReadStreamEndian *getResource(uint32 tag, uint16 id) override;
	Common::String formatArchiveInfo() override;

	uint32 _startOffset;
};

class RIFXArchive : public Archive {
public:
	RIFXArchive();
	~RIFXArchive() override;

	bool openStream(Common::SeekableReadStream *stream, uint32 startOffset = 0) override;
	bool writeToFile(Common::String filename, Movie *movie) override;

	Common::SeekableReadStreamEndian *getFirstResource(uint32 tag) override;
	virtual Common::SeekableReadStreamEndian *getFirstResource(uint32 tag, bool fileEndianness);
	Common::SeekableReadStreamEndian *getFirstResource(uint32 tag, uint16 parentId) override;
	Common::SeekableReadStreamEndian *getResource(uint32 tag, uint16 id) override;
	virtual Common::SeekableReadStreamEndian *getResource(uint32 tag, uint16 id, bool fileEndianness);
	Resource getResourceDetail(uint32 tag, uint16 id) override;
	Common::String formatArchiveInfo() override;

private:
	/* archive-save.cpp */
	/* These functions are for writing movies */
	bool writeMemoryMap(Common::SeekableWriteStream *writeStream, Common::Array<Resource *> resource); 	// Parallel to readMemoryMap
	bool writeAfterBurnerMap(Common::SeekableWriteStream *writeStreaa);	// Parallel to readAfterBurnerMap
	bool writeKeyTable(Common::SeekableWriteStream *writeStream, uint32 offset);	// Parallel to readKeyTable
	bool writeCast(Common::SeekableWriteStream *writeStream, uint32 offset, uint32 castLib);	// Parallel to readCast

	uint32 getArchiveSize(Common::Array<Resource *> resources);
	uint32 getMmapSize();
	uint32 getImapSize();
	uint32 getCASResourceSize(uint32 castLib);
	uint32 getKeyTableResourceSize();
	Common::Array<Resource *> rebuildResources(Movie *movie);

	bool readMemoryMap(Common::SeekableReadStreamEndian &stream, uint32 moreOffset, Common::SeekableMemoryWriteStream *dumpStream, uint32 movieStartOffset);
	bool readAfterburnerMap(Common::SeekableReadStreamEndian &stream, uint32 moreOffset);
	void readCast(Common::SeekableReadStreamEndian &casStream, uint16 libResourceId);
	void readKeyTable(Common::SeekableReadStreamEndian &keyStream);

	uint32 findParentIndex(uint32 tag, uint16 index);

	/* Memory Map data to save the file */
	uint32 _metaTag;
	uint32 _mapversion;
	uint32 _mmapHeaderSize;
	uint32 _mmapEntrySize;
	uint32 _totalCount;
	uint32 _resCount;
	uint32 _imapLength;
	uint32 _version;
	uint32 _size;

	/* Key Table data to save the file */
	uint16 _keyTableEntrySize;
	uint16 _keyTableEntrySize2;
	uint32 _keyTableEntryCount;
	uint32 _keyTableUsedCount;

	/* AfterBurner data to save the file */
	uint32 _fverLength;
	uint32 _afterBurnerVersion;
	uint32 _fcdrLength;
	uint32 _abmpLength;
	uint32 _abmpEnd;
	uint32 _abmpCompressionType;
	uint32 _abmpUncompLength;
	uint32 _abmpActualUncompLength;

protected:
	uint32 _rifxType;

	// Each resource is independent
	Common::Array<Resource *> _resources;
	Common::HashMap<uint32, byte *> _ilsData;
	uint32 _ilsBodyOffset;
	typedef Common::Array<uint32> KeyArray;
	typedef Common::HashMap<uint32, KeyArray> KeyMap;

	// In the RIFX container type, some resources are related of other resources in a child-parent relation
	// If you want to check the relation between a 'BITD' resource and some other resource (e.g. 'CASt')
	// Check if index of 'BITD' resource is present in _keyData['BITD'][index of 'CASt' resource]
	Common::HashMap<uint32, KeyMap> _keyData;
};

/*******************************************
 *
 * Projector Archive
 *
 *******************************************/

class ProjectorArchive : public Common::Archive {
public:
	ProjectorArchive(Common::Path path);
	~ProjectorArchive() override;

	bool hasFile(const Common::Path &path) const override;
	int listMembers(Common::ArchiveMemberList &list) const override;
	const Common::ArchiveMemberPtr getMember(const Common::Path &path) const override;
	Common::SeekableReadStream *createReadStreamForMember(const Common::Path &path) const override;
	bool isLoaded() { return _isLoaded; }
private:
	Common::SeekableReadStream *createBufferedReadStream();
	bool loadArchive(Common::SeekableReadStream *stream);

	struct Entry {
		uint32 offset;
		uint32 size;
	};
	typedef Common::HashMap<Common::Path, Entry, Common::Path::IgnoreCase_Hash, Common::Path::IgnoreCase_EqualTo> FileMap;
	FileMap _files;
	Common::Path _path;

	bool _isLoaded;
};

void dumpFile(Common::String filename, uint32 id, uint32 tag, byte *dumpData, uint32 dumpSize);

class SavedArchive : public Common::Archive {
public:
	SavedArchive(Common::String target) ;
	bool hasFile(const Common::Path &path) const override;
	int listMembers(Common::ArchiveMemberList &list) const override;
	const Common::ArchiveMemberPtr getMember(const Common::Path &path) const override;
	Common::SeekableReadStream *createReadStreamForMember(const Common::Path &path) const override;

private:
	typedef Common::HashMap<Common::String, Common::String> FileMap;
	FileMap _files;
};

}
#endif