tmx2gba/src/tmxmap.cpp

// SPDX-License-Identifier: Zlib
// SPDX-FileCopyrightText: (c) 2015-2024 a dinosaur

#include "tmxmap.hpp"
#include "strtools.hpp"
#include "config.h"
#include <pugixml.hpp>
#include <base64.h>
#ifdef USE_ZLIB
# include <zlib.h>
#else
# include "gzip.hpp"
#endif
#include <zstd.h>
#include <cerrno>
#include <algorithm>


enum class Encoding { XML, BASE64, CSV, INVALID };
enum class Compression { NONE, GZIP, ZLIB, ZSTD, INVALID };

[[nodiscard]] static Encoding EncodingFromStr(const std::string_view str)
{
	if (str.empty())     { return Encoding::XML; }
	if (str == "base64") { return Encoding::BASE64; }
	if (str == "csv")    { return Encoding::CSV; }
	return Encoding::INVALID;
}

[[nodiscard]] static Compression CompressionFromStr(const std::string_view str)
{
	if (str.empty())   { return Compression::NONE; }
	if (str == "gzip") { return Compression::GZIP; }
	if (str == "zlib") { return Compression::ZLIB; }
	if (str == "zstd") { return Compression::ZSTD; }
	return Compression::INVALID;
}


[[nodiscard]] static bool DecodeBase64(
	std::vector<uint32_t>& out, size_t numTiles,
	const std::string_view base64, Compression compression)
{
	auto decoded = base64_decode(TrimWhitespace(base64));
	if (decoded.empty()) { return false; }
	const std::span source(reinterpret_cast<const uint8_t*>(decoded.data()), decoded.size());

	//FIXME: lmao what is big endian
	switch (compression)
	{
	case Compression::GZIP:
#ifndef USE_ZLIB
		{
			out.resize(numTiles);
			GZipReader reader;
			if (!reader.OpenMemory(source) ||
				!reader.Read({ reinterpret_cast<uint8_t*>(out.data()), sizeof(uint32_t) * numTiles }) ||
				!reader.Check())
				return false;
			return true;
		}
#endif
	case Compression::ZLIB:
		{
			out.resize(numTiles);
			// Decompress gzip/zlib data with zlib/zlib data miniz
			z_stream s =
			{
				.next_in  = const_cast<Bytef*>(source.data()),
				.avail_in = static_cast<unsigned int>(source.size()),
				.next_out  = reinterpret_cast<Bytef*>(out.data()),
				.avail_out = static_cast<unsigned int>(sizeof(uint32_t) * numTiles),
				.zalloc = nullptr, .zfree = nullptr, .opaque = nullptr
			};
#ifdef USE_ZLIB
			const int wbits = (compression == Compression::GZIP) ? MAX_WBITS | 16 : MAX_WBITS;
#else
			const int wbits = MZ_DEFAULT_WINDOW_BITS;
#endif
			if (inflateInit2(&s, wbits) != Z_OK)
				return false;
			int res = inflate(&s, Z_FINISH);
			inflateEnd(&s);
			return res == Z_STREAM_END;
		}
	case Compression::ZSTD:
		{
			out.resize(numTiles);
			auto res = ZSTD_decompress(
				reinterpret_cast<void*>(out.data()),
				sizeof(uint32_t) * numTiles,
				source.data(), source.size());
			return !ZSTD_isError(res);
		}
	case Compression::NONE:
		{
			out.reserve(numTiles);
			const auto end = source.end();
			for (auto it = source.begin(); it < end - 3;)
			{
				uint32_t tile = *it++;
				tile |= static_cast<uint32_t>(*it++) <<  8u;
				tile |= static_cast<uint32_t>(*it++) << 16u;
				tile |= static_cast<uint32_t>(*it++) << 24u;
				out.emplace_back(tile);
			}
			return true;
		}
	case Compression::INVALID:
	default: return false;
	}
}

void TmxMap::ReadTileset(const pugi::xml_node& xNode)
{
	std::string_view name   = xNode.attribute("name").value();
	std::string_view source = xNode.attribute("source").value();

	auto firstGid = UintFromStr<uint32_t>(xNode.attribute("firstgid").value()).value_or(0);
	auto numTiles = UintFromStr<uint32_t>(xNode.attribute("tilecount").value()).value_or(0);
	if (numTiles == 0)
		return; // FIXME: warn about empty tilesets or something

	mTilesets.emplace_back(TmxTileset(name, source, firstGid, numTiles));
}

void TmxMap::ReadLayer(const pugi::xml_node& xNode)
{
	std::string_view name = xNode.attribute("name").value();

	// Read layer size
	int width  = IntFromStr<int>(xNode.attribute("width").value()).value_or(0);
	int height = IntFromStr<int>(xNode.attribute("height").value()).value_or(0);
	if (width <= 0 || height <= 0) { return; }
	const auto numTiles = static_cast<size_t>(width) * static_cast<size_t>(height);

	auto xData = xNode.child("data");
	if (xData.empty() || xData.first_child().empty())
		return;

	// Read data
	std::vector<uint32_t> tileDat;
	auto encoding = EncodingFromStr(xData.attribute("encoding").value());
	if (encoding == Encoding::BASE64)
	{
		const std::string_view base64(xData.child_value());
		if (base64.empty())
			return;

		const auto compression = CompressionFromStr(xData.attribute("compression").value());
		if (compression == Compression::INVALID || !DecodeBase64(tileDat, numTiles, base64, compression))
			return;
	}
	else if (encoding == Encoding::XML)
	{
		tileDat.reserve(numTiles);
		std::ranges::transform(xData.children("tile"), std::back_inserter(tileDat), [](auto it)
		-> uint32_t { return UintFromStr<uint32_t>(it.attribute("gid").value()).value_or(0); });
	}
	else if (encoding == Encoding::CSV)
	{
		tileDat.reserve(numTiles);
		const std::string_view csv(xData.child_value());

		std::string::size_type pos = 0;
		while (true)
		{
			// TODO: check if this has a problem on other locales?
			auto gid = UintFromStr<uint32_t>(csv.substr(pos).data());
			if (gid.has_value())
				tileDat.emplace_back(gid.value());

			if ((pos = csv.find(',', pos)) == std::string::npos)
				break;
			++pos;
		}
	}
	else { return; }

	mLayers.emplace_back(TmxLayer(width, height, name, std::move(tileDat)));
}

void TmxMap::ReadObjectGroup(const pugi::xml_node& xNode)
{
	std::string_view name(xNode.value());
	std::vector<TmxObject> objects;

	const auto xObjects = xNode.children("object");
	//mObjects.reserve(xObjects.size())
	for (const auto it : xObjects)
	{
		int id = IntFromStr<int>(it.attribute("id").value()).value_or(0);
		std::string_view name = it.attribute("name").value();

		// Read axis-aligned bounding box
		auto x = FloatFromStr<float>(it.attribute("x").value()).value_or(0.0f);
		auto y = FloatFromStr<float>(it.attribute("y").value()).value_or(0.0f);
		auto width  = FloatFromStr<float>(it.attribute("width").value()).value_or(0.0f);
		auto height = FloatFromStr<float>(it.attribute("height").value()).value_or(0.0f);

		objects.emplace_back(TmxObject(id, name, { x, y, width, height }));
	}

	if (objects.empty())
		return; //FIXME: log this
	mObjectGroups.emplace_back(TmxObjectGroup(name, std::move(objects)));
}

bool TmxMap::Load(const std::string& inPath)
{
	// Parse document
	pugi::xml_document xDoc;
	auto res = xDoc.load_file(inPath.c_str());
	if (res.status != pugi::xml_parse_status::status_ok)
		return false;

	// Get map node
	auto xMap = xDoc.child("map");
	if (xMap.empty())
		return false;

	// Read map attribs
	mWidth  = IntFromStr<int>(xMap.attribute("width").value()).value_or(0);
	mHeight = IntFromStr<int>(xMap.attribute("height").value()).value_or(0);

	// Read nodes
	for (auto it : xMap.children())
	{
		std::string_view name(it.name());
		if      (!name.compare("layer"))       { ReadLayer(it); }
		else if (!name.compare("tileset"))     { ReadTileset(it); }
		else if (!name.compare("objectgroup")) { ReadObjectGroup(it); }
	}

	return true;
}