rom-properties/src/librptexture/fileformat/ASTC.cpp

/***************************************************************************
 * ROM Properties Page shell extension. (librptexture)                     *
 * ASTC.hpp: ASTC image reader.                                            *
 *                                                                         *
 * Copyright (c) 2017-2025 by David Korth.                                 *
 * SPDX-License-Identifier: GPL-2.0-or-later                               *
 ***************************************************************************/

#include "stdafx.h"
#include "ASTC.hpp"
#include "FileFormat_p.hpp"

#include "astc_structs.h"

// Other rom-properties libraries
using namespace LibRpFile;
using LibRpBase::RomFields;

// librptexture
#include "ImageSizeCalc.hpp"
#include "img/rp_image.hpp"
#include "decoder/ImageDecoder_ASTC.hpp"

// C++ STL classes
using std::array;
using std::string;

namespace LibRpTexture {

class ASTCPrivate final : public FileFormatPrivate
{
	public:
		ASTCPrivate(ASTC *q, const IRpFilePtr &file);

	private:
		typedef FileFormatPrivate super;
		RP_DISABLE_COPY(ASTCPrivate)

	public:
		/** TextureInfo **/
		static const array<const char*, 2+1> exts;
		static const array<const char*, 1+1> mimeTypes;
		static const TextureInfo textureInfo;

	public:
		// ASTC header
		ASTC_Header astcHeader;

		// Decoded image
		rp_image_ptr img;

		// Pixel format message
		mutable string pixel_format;

		/**
		 * Load the image.
		 * @return Image, or nullptr on error.
		 */
		rp_image_const_ptr loadImage(void);
};

FILEFORMAT_IMPL(ASTC)

/** ASTCPrivate **/

/* TextureInfo */
const array<const char*, 2+1> ASTCPrivate::exts = {{
	".astc",
	".dds",	// Some .dds files are actually ASTC.

	nullptr
}};
const array<const char*, 1+1> ASTCPrivate::mimeTypes = {{
	// Official MIME types.
	"image/astc",

	nullptr
}};
const TextureInfo ASTCPrivate::textureInfo = {
	exts.data(), mimeTypes.data()
};

ASTCPrivate::ASTCPrivate(ASTC *q, const IRpFilePtr &file)
	: super(q, file, &textureInfo)
{
	// Clear the structs and arrays.
	memset(&astcHeader, 0, sizeof(astcHeader));
}

/**
 * Load the image.
 * @return Image, or nullptr on error.
 */
rp_image_const_ptr ASTCPrivate::loadImage(void)
{
	if (img) {
		// Image has already been loaded.
		return img;
	} else if (!this->isValid || !this->file) {
		// Can't load the image.
		return {};
	}

#ifdef ENABLE_ASTC
	// NOTE: We can't use astcHeader's width/height fields because
	// they're 24-bit values. Use dimensions[] instead.

	// Sanity check: Maximum image dimensions of 32768x32768.
	// NOTE: `height == 0` is allowed here. (1D texture)
	assert(dimensions[0] > 0);
	assert(dimensions[0] <= 32768);
	assert(dimensions[1] <= 32768);
	if (dimensions[0] == 0 || dimensions[0] > 32768 ||
	    dimensions[1] > 32768)
	{
		// Invalid image dimensions.
		return {};
	}

	if (dimensions[2] > 1) {
		// 3D textures are not supported.
		return {};
	}

	if (file->size() > 128*1024*1024) {
		// Sanity check: VTF files shouldn't be more than 128 MB.
		return {};
	}
	const uint32_t file_sz = static_cast<uint32_t>(file->size());

	// Handle a 1D texture as a "width x 1" 2D texture.
	// NOTE: Handling a 3D texture as a single 2D texture.
	const int height = (dimensions[1] > 0 ? dimensions[1] : 1);

	// Calculate the expected size.
	const unsigned int expected_size = ImageSizeCalc::calcImageSizeASTC(
		dimensions[0], height,
		astcHeader.blockdimX, astcHeader.blockdimY);
	if (expected_size == 0 || expected_size > file_sz) {
		// Invalid image size.
		return {};
	}

	// The ASTC file format does not support mipmaps.
	// The texture data is located directly after the header.
	const unsigned int texDataStartAddr = static_cast<unsigned int>(sizeof(astcHeader));

	// Seek to the start of the texture data.
	int ret = file->seek(texDataStartAddr);
	if (ret != 0) {
		// Seek error.
		return {};
	}

	// Read the texture data.
	auto buf = aligned_uptr<uint8_t>(16, expected_size);
	size_t size = file->read(buf.get(), expected_size);
	if (size != expected_size) {
		// Read error.
		return {};
	}

	// Decode the image.
	img = ImageDecoder::fromASTC(
		dimensions[0], height,
		buf.get(), expected_size,
		astcHeader.blockdimX, astcHeader.blockdimY);
	return img;
#else /* !ENABLE_ASTC */
	// ASTC decoder is disabled.
	return {};
#endif /* ENABLE_ASTC */
}

/** ASTC **/

/**
 * Read an ASTC image file.
 *
 * A ROM image must be opened by the caller. The file handle
 * will be ref()'d and must be kept open in order to load
 * data from the ROM image.
 *
 * To close the file, either delete this object or call close().
 *
 * NOTE: Check isValid() to determine if this is a valid ROM.
 *
 * @param file Open ROM image.
 */
ASTC::ASTC(const IRpFilePtr &file)
	: super(new ASTCPrivate(this, file))
{
	RP_D(ASTC);
	d->mimeType = "image/astc";	// official
	d->textureFormatName = "ASTC";

	if (!d->file) {
		// Could not ref() the file handle.
		return;
	}

	// Read the ASTC header.
	d->file->rewind();
	size_t size = d->file->read(&d->astcHeader, sizeof(d->astcHeader));
	if (size != sizeof(d->astcHeader)) {
		d->file.reset();
		return;
	}

	// Verify the ASTC magic.
	if (d->astcHeader.magic != cpu_to_le32(ASTC_MAGIC)) {
		// Incorrect magic.
		d->file.reset();
		return;
	}

	// File is valid.
	d->isValid = true;

	// Cache the dimensions for the FileFormat base class.
	d->dimensions[0] = (d->astcHeader.width[2] << 16) |
	                   (d->astcHeader.width[1] <<  8) |
	                    d->astcHeader.width[0];
	d->dimensions[1] = (d->astcHeader.height[2] << 16) |
	                   (d->astcHeader.height[1] <<  8) |
	                    d->astcHeader.height[0];

	const unsigned int depth = (d->astcHeader.depth[2] << 16) |
	                           (d->astcHeader.depth[1] <<  8) |
	                            d->astcHeader.depth[0];
	if (depth > 1) {
		d->dimensions[2] = depth;
	}
}

/** Property accessors **/

/**
 * Get the pixel format, e.g. "RGB888" or "DXT1".
 * @return Pixel format, or nullptr if unavailable.
 */
const char *ASTC::pixelFormat(void) const
{
	RP_D(const ASTC);
	if (!d->isValid) {
		return nullptr;
	}

	if (d->pixel_format.empty()) {
		if (d->dimensions[2] <= 1) {
			d->pixel_format = fmt::format(FSTR("ASTC_{:d}x{:d}"),
				d->astcHeader.blockdimX, d->astcHeader.blockdimY);
		} else {
			d->pixel_format = fmt::format(FSTR("ASTC_{:d}x{:d}x{:d}"),
				d->astcHeader.blockdimX, d->astcHeader.blockdimY, d->astcHeader.blockdimZ);
		}
	}
	return d->pixel_format.c_str();
}

#ifdef ENABLE_LIBRPBASE_ROMFIELDS
/**
 * Get property fields for rom-properties.
 * @param fields RomFields object to which fields should be added.
 * @return Number of fields added, or 0 on error.
 */
int ASTC::getFields(RomFields *fields) const
{
	assert(fields != nullptr);
	if (!fields)
		return 0;

	RP_D(const ASTC);
	if (!d->isValid) {
		// Unknown file type.
		return -EIO;
	}

	// TODO: Add fields?
	return 0;
}
#endif /* ENABLE_LIBRPBASE_ROMFIELDS */

/** Image accessors **/

/**
 * Get the image.
 * For textures with mipmaps, this is the largest mipmap.
 * The image is owned by this object.
 * @return Image, or nullptr on error.
 */
rp_image_const_ptr ASTC::image(void) const
{
	RP_D(const ASTC);
	if (!d->isValid) {
		// Unknown file type.
		return nullptr;
	}

	// Load the image.
	return const_cast<ASTCPrivate*>(d)->loadImage();
}

} // namespace LibRpTexture