summaryrefslogtreecommitdiffstats
path: root/modules/basis_universal/image_compress_basisu.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'modules/basis_universal/image_compress_basisu.cpp')
-rw-r--r--modules/basis_universal/image_compress_basisu.cpp251
1 files changed, 251 insertions, 0 deletions
diff --git a/modules/basis_universal/image_compress_basisu.cpp b/modules/basis_universal/image_compress_basisu.cpp
new file mode 100644
index 0000000000..41de62b20b
--- /dev/null
+++ b/modules/basis_universal/image_compress_basisu.cpp
@@ -0,0 +1,251 @@
+/**************************************************************************/
+/* image_compress_basisu.cpp */
+/**************************************************************************/
+/* This file is part of: */
+/* GODOT ENGINE */
+/* https://godotengine.org */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
+/* */
+/* Permission is hereby granted, free of charge, to any person obtaining */
+/* a copy of this software and associated documentation files (the */
+/* "Software"), to deal in the Software without restriction, including */
+/* without limitation the rights to use, copy, modify, merge, publish, */
+/* distribute, sublicense, and/or sell copies of the Software, and to */
+/* permit persons to whom the Software is furnished to do so, subject to */
+/* the following conditions: */
+/* */
+/* The above copyright notice and this permission notice shall be */
+/* included in all copies or substantial portions of the Software. */
+/* */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
+/**************************************************************************/
+
+#include "image_compress_basisu.h"
+
+#include "servers/rendering_server.h"
+
+#include <transcoder/basisu_transcoder.h>
+#ifdef TOOLS_ENABLED
+#include <encoder/basisu_comp.h>
+#endif
+
+void basis_universal_init() {
+#ifdef TOOLS_ENABLED
+ basisu::basisu_encoder_init();
+#endif
+
+ basist::basisu_transcoder_init();
+}
+
+#ifdef TOOLS_ENABLED
+Vector<uint8_t> basis_universal_packer(const Ref<Image> &p_image, Image::UsedChannels p_channels) {
+ Ref<Image> image = p_image->duplicate();
+ image->convert(Image::FORMAT_RGBA8);
+
+ basisu::basis_compressor_params params;
+
+ params.m_uastc = true;
+ params.m_quality_level = basisu::BASISU_QUALITY_MIN;
+ params.m_pack_uastc_flags &= ~basisu::cPackUASTCLevelMask;
+ params.m_pack_uastc_flags |= basisu::cPackUASTCLevelFastest;
+
+ params.m_rdo_uastc = 0.0f;
+ params.m_rdo_uastc_quality_scalar = 0.0f;
+ params.m_rdo_uastc_dict_size = 1024;
+
+ params.m_mip_fast = true;
+ params.m_multithreading = true;
+ params.m_check_for_alpha = false;
+
+ basisu::job_pool job_pool(OS::get_singleton()->get_processor_count());
+ params.m_pJob_pool = &job_pool;
+
+ BasisDecompressFormat decompress_format = BASIS_DECOMPRESS_RG;
+ switch (p_channels) {
+ case Image::USED_CHANNELS_L: {
+ decompress_format = BASIS_DECOMPRESS_RGB;
+ } break;
+ case Image::USED_CHANNELS_LA: {
+ params.m_force_alpha = true;
+ decompress_format = BASIS_DECOMPRESS_RGBA;
+ } break;
+ case Image::USED_CHANNELS_R: {
+ decompress_format = BASIS_DECOMPRESS_RGB;
+ } break;
+ case Image::USED_CHANNELS_RG: {
+ // Currently RG textures are compressed as DXT5/ETC2_RGBA8 with a RA -> RG swizzle,
+ // as BasisUniversal didn't use to support ETC2_RG11 transcoding.
+ params.m_force_alpha = true;
+ image->convert_rg_to_ra_rgba8();
+ decompress_format = BASIS_DECOMPRESS_RG_AS_RA;
+ } break;
+ case Image::USED_CHANNELS_RGB: {
+ decompress_format = BASIS_DECOMPRESS_RGB;
+ } break;
+ case Image::USED_CHANNELS_RGBA: {
+ params.m_force_alpha = true;
+ decompress_format = BASIS_DECOMPRESS_RGBA;
+ } break;
+ }
+
+ {
+ // Encode the image with mipmaps.
+ Vector<uint8_t> image_data = image->get_data();
+ basisu::vector<basisu::image> basisu_mipmaps;
+
+ for (int32_t i = 0; i <= image->get_mipmap_count(); i++) {
+ int ofs, size, width, height;
+ image->get_mipmap_offset_size_and_dimensions(i, ofs, size, width, height);
+
+ basisu::image basisu_image(width, height);
+ memcpy(basisu_image.get_ptr(), image_data.ptr() + ofs, size);
+
+ if (i == 0) {
+ params.m_source_images.push_back(basisu_image);
+ } else {
+ basisu_mipmaps.push_back(basisu_image);
+ }
+ }
+
+ params.m_source_mipmap_images.push_back(basisu_mipmaps);
+ }
+
+ // Encode the image data.
+ Vector<uint8_t> basisu_data;
+
+ basisu::basis_compressor compressor;
+ compressor.init(params);
+
+ int basisu_err = compressor.process();
+ ERR_FAIL_COND_V(basisu_err != basisu::basis_compressor::cECSuccess, basisu_data);
+
+ const basisu::uint8_vec &basisu_out = compressor.get_output_basis_file();
+ basisu_data.resize(basisu_out.size() + 4);
+
+ // Copy the encoded data to the buffer.
+ {
+ uint8_t *w = basisu_data.ptrw();
+ *(uint32_t *)w = decompress_format;
+
+ memcpy(w + 4, basisu_out.get_ptr(), basisu_out.size());
+ }
+
+ return basisu_data;
+}
+#endif // TOOLS_ENABLED
+
+Ref<Image> basis_universal_unpacker_ptr(const uint8_t *p_data, int p_size) {
+ Ref<Image> image;
+ ERR_FAIL_NULL_V_MSG(p_data, image, "Cannot unpack invalid BasisUniversal data.");
+
+ const uint8_t *src_ptr = p_data;
+ int src_size = p_size;
+
+ basist::transcoder_texture_format basisu_format = basist::transcoder_texture_format::cTFTotalTextureFormats;
+ Image::Format image_format = Image::FORMAT_MAX;
+
+ // Get supported compression formats.
+ bool bptc_supported = RS::get_singleton()->has_os_feature("bptc");
+ bool s3tc_supported = RS::get_singleton()->has_os_feature("s3tc");
+ bool etc2_supported = RS::get_singleton()->has_os_feature("etc2");
+
+ switch (*(uint32_t *)(src_ptr)) {
+ case BASIS_DECOMPRESS_RG: {
+ // RGTC transcoding is currently performed with RG_AS_RA, fail.
+ ERR_FAIL_V(image);
+ } break;
+ case BASIS_DECOMPRESS_RGB: {
+ if (bptc_supported) {
+ basisu_format = basist::transcoder_texture_format::cTFBC7_M6_OPAQUE_ONLY;
+ image_format = Image::FORMAT_BPTC_RGBA;
+ } else if (s3tc_supported) {
+ basisu_format = basist::transcoder_texture_format::cTFBC1;
+ image_format = Image::FORMAT_DXT1;
+ } else if (etc2_supported) {
+ basisu_format = basist::transcoder_texture_format::cTFETC1;
+ image_format = Image::FORMAT_ETC2_RGB8;
+ } else {
+ // No supported VRAM compression formats, decompress.
+ basisu_format = basist::transcoder_texture_format::cTFRGBA32;
+ image_format = Image::FORMAT_RGBA8;
+ }
+
+ } break;
+ case BASIS_DECOMPRESS_RGBA: {
+ if (bptc_supported) {
+ basisu_format = basist::transcoder_texture_format::cTFBC7_M5;
+ image_format = Image::FORMAT_BPTC_RGBA;
+ } else if (s3tc_supported) {
+ basisu_format = basist::transcoder_texture_format::cTFBC3;
+ image_format = Image::FORMAT_DXT5;
+ } else if (etc2_supported) {
+ basisu_format = basist::transcoder_texture_format::cTFETC2;
+ image_format = Image::FORMAT_ETC2_RGBA8;
+ } else {
+ // No supported VRAM compression formats, decompress.
+ basisu_format = basist::transcoder_texture_format::cTFRGBA32;
+ image_format = Image::FORMAT_RGBA8;
+ }
+ } break;
+ case BASIS_DECOMPRESS_RG_AS_RA: {
+ if (s3tc_supported) {
+ basisu_format = basist::transcoder_texture_format::cTFBC3;
+ image_format = Image::FORMAT_DXT5_RA_AS_RG;
+ } else if (etc2_supported) {
+ basisu_format = basist::transcoder_texture_format::cTFETC2;
+ image_format = Image::FORMAT_ETC2_RA_AS_RG;
+ } else {
+ // No supported VRAM compression formats, decompress.
+ basisu_format = basist::transcoder_texture_format::cTFRGBA32;
+ image_format = Image::FORMAT_RGBA8;
+ }
+ } break;
+ }
+
+ src_ptr += 4;
+ src_size -= 4;
+
+ basist::basisu_transcoder transcoder;
+ ERR_FAIL_COND_V(!transcoder.validate_header(src_ptr, src_size), image);
+
+ transcoder.start_transcoding(src_ptr, src_size);
+
+ basist::basisu_image_info basisu_info;
+ transcoder.get_image_info(src_ptr, src_size, basisu_info, 0);
+
+ Vector<uint8_t> out_data;
+ out_data.resize(Image::get_image_data_size(basisu_info.m_width, basisu_info.m_height, image_format, basisu_info.m_total_levels > 1));
+
+ uint8_t *dst = out_data.ptrw();
+ memset(dst, 0, out_data.size());
+
+ uint32_t mip_count = Image::get_image_required_mipmaps(basisu_info.m_orig_width, basisu_info.m_orig_height, image_format);
+ for (uint32_t i = 0; i <= mip_count; i++) {
+ basist::basisu_image_level_info basisu_level;
+ transcoder.get_image_level_info(src_ptr, src_size, basisu_level, 0, i);
+
+ int ofs = Image::get_image_mipmap_offset(basisu_info.m_width, basisu_info.m_height, image_format, i);
+ bool result = transcoder.transcode_image_level(src_ptr, src_size, 0, i, dst + ofs, basisu_level.m_total_blocks, basisu_format);
+
+ if (!result) {
+ print_line(vformat("BasisUniversal cannot unpack level %d.", i));
+ break;
+ }
+ }
+
+ image = Image::create_from_data(basisu_info.m_width, basisu_info.m_height, basisu_info.m_total_levels > 1, image_format, out_data);
+
+ return image;
+}
+
+Ref<Image> basis_universal_unpacker(const Vector<uint8_t> &p_buffer) {
+ return basis_universal_unpacker_ptr(p_buffer.ptr(), p_buffer.size());
+}