Path: blob/master/modules/ktx/texture_loader_ktx.cpp
11389 views
/**************************************************************************/1/* texture_loader_ktx.cpp */2/**************************************************************************/3/* This file is part of: */4/* GODOT ENGINE */5/* https://godotengine.org */6/**************************************************************************/7/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */8/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */9/* */10/* Permission is hereby granted, free of charge, to any person obtaining */11/* a copy of this software and associated documentation files (the */12/* "Software"), to deal in the Software without restriction, including */13/* without limitation the rights to use, copy, modify, merge, publish, */14/* distribute, sublicense, and/or sell copies of the Software, and to */15/* permit persons to whom the Software is furnished to do so, subject to */16/* the following conditions: */17/* */18/* The above copyright notice and this permission notice shall be */19/* included in all copies or substantial portions of the Software. */20/* */21/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */22/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */23/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */24/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */25/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */26/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */27/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */28/**************************************************************************/2930#include "texture_loader_ktx.h"3132#include "core/io/file_access.h"33#include "core/io/file_access_memory.h"34#include "scene/resources/image_texture.h"3536#include <ktx.h>37#include <vk_format.h>3839KTX_error_code ktx_read(ktxStream *stream, void *dst, const ktx_size_t count) {40Ref<FileAccess> *f = reinterpret_cast<Ref<FileAccess> *>(stream->data.custom_ptr.address);41(*f)->get_buffer(reinterpret_cast<uint8_t *>(dst), count);42return KTX_SUCCESS;43}4445KTX_error_code ktx_skip(ktxStream *stream, const ktx_size_t count) {46Ref<FileAccess> *f = reinterpret_cast<Ref<FileAccess> *>(stream->data.custom_ptr.address);47for (ktx_size_t i = 0; i < count; ++i) {48(*f)->get_8();49}50return KTX_SUCCESS;51}5253KTX_error_code ktx_write(ktxStream *stream, const void *src, const ktx_size_t size, const ktx_size_t count) {54Ref<FileAccess> *f = reinterpret_cast<Ref<FileAccess> *>(stream->data.custom_ptr.address);55(*f)->store_buffer(reinterpret_cast<const uint8_t *>(src), size * count);56return KTX_SUCCESS;57}5859KTX_error_code ktx_getpos(ktxStream *stream, ktx_off_t *const offset) {60Ref<FileAccess> *f = reinterpret_cast<Ref<FileAccess> *>(stream->data.custom_ptr.address);61*offset = (*f)->get_position();62return KTX_SUCCESS;63}6465KTX_error_code ktx_setpos(ktxStream *stream, const ktx_off_t offset) {66Ref<FileAccess> *f = reinterpret_cast<Ref<FileAccess> *>(stream->data.custom_ptr.address);67(*f)->seek(offset);68return KTX_SUCCESS;69}7071KTX_error_code ktx_getsize(ktxStream *stream, ktx_size_t *const size) {72Ref<FileAccess> *f = reinterpret_cast<Ref<FileAccess> *>(stream->data.custom_ptr.address);73*size = (*f)->get_length();74return KTX_SUCCESS;75}7677void ktx_destruct(ktxStream *stream) {78(void)stream;79}8081static Ref<Image> load_from_file_access(Ref<FileAccess> f, Error *r_error) {82ktxStream ktx_stream;83ktx_stream.read = ktx_read;84ktx_stream.skip = ktx_skip;85ktx_stream.write = ktx_write;86ktx_stream.getpos = ktx_getpos;87ktx_stream.setpos = ktx_setpos;88ktx_stream.getsize = ktx_getsize;89ktx_stream.destruct = ktx_destruct;90ktx_stream.type = eStreamTypeCustom;91ktx_stream.data.custom_ptr.address = &f;92ktx_stream.data.custom_ptr.allocatorAddress = nullptr;93ktx_stream.data.custom_ptr.size = 0;94ktx_stream.readpos = 0;95ktx_stream.closeOnDestruct = false;96ktxTexture *ktx_texture;97KTX_error_code result = ktxTexture_CreateFromStream(&ktx_stream,98KTX_TEXTURE_CREATE_LOAD_IMAGE_DATA_BIT,99&ktx_texture);100if (result != KTX_SUCCESS) {101ERR_FAIL_V_MSG(Ref<Resource>(), "Invalid or unsupported KTX texture file.");102}103104if (ktx_texture->numDimensions != 2) {105ktxTexture_Destroy(ktx_texture);106ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported non-2D KTX texture file.");107}108109if (ktx_texture->isCubemap || ktx_texture->numFaces != 1) {110ktxTexture_Destroy(ktx_texture);111ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported cube map KTX texture file.");112}113114if (ktx_texture->isArray) {115ktxTexture_Destroy(ktx_texture);116ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported array KTX texture file.");117}118119uint32_t width = ktx_texture->baseWidth;120uint32_t height = ktx_texture->baseHeight;121uint32_t mipmaps = ktx_texture->numLevels;122Image::Format format;123bool srgb = false;124125switch (ktx_texture->classId) {126case ktxTexture1_c:127switch (((ktxTexture1 *)ktx_texture)->glInternalformat) {128case GL_LUMINANCE:129format = Image::FORMAT_L8;130break;131case GL_LUMINANCE_ALPHA:132format = Image::FORMAT_LA8;133break;134case GL_SRGB8:135format = Image::FORMAT_RGB8;136srgb = true;137break;138case GL_SRGB8_ALPHA8:139format = Image::FORMAT_RGBA8;140srgb = true;141break;142case GL_R8:143case GL_R8UI:144format = Image::FORMAT_R8;145break;146case GL_RG8:147format = Image::FORMAT_RG8;148break;149case GL_RGB8:150format = Image::FORMAT_RGB8;151break;152case GL_RGBA8:153format = Image::FORMAT_RGBA8;154break;155case GL_RGBA4:156format = Image::FORMAT_RGBA4444;157break;158case GL_RGB565:159format = Image::FORMAT_RGB565;160break;161case GL_R32F:162format = Image::FORMAT_RF;163break;164case GL_RG32F:165format = Image::FORMAT_RGF;166break;167case GL_RGB32F:168format = Image::FORMAT_RGBF;169break;170case GL_RGBA32F:171format = Image::FORMAT_RGBAF;172break;173case GL_R16F:174format = Image::FORMAT_RH;175break;176case GL_RG16F:177format = Image::FORMAT_RGH;178break;179case GL_RGB16F:180format = Image::FORMAT_RGBH;181break;182case GL_RGBA16F:183format = Image::FORMAT_RGBAH;184break;185case GL_RGB9_E5:186format = Image::FORMAT_RGBE9995;187break;188case GL_R16:189format = Image::FORMAT_R16;190break;191case GL_RG16:192format = Image::FORMAT_RG16;193break;194case GL_RGB16:195format = Image::FORMAT_RGB16;196break;197case GL_RGBA16:198format = Image::FORMAT_RGBA16;199break;200case GL_R16UI:201format = Image::FORMAT_R16I;202break;203case GL_RG16UI:204format = Image::FORMAT_RG16I;205break;206case GL_RGB16UI:207format = Image::FORMAT_RGB16I;208break;209case GL_RGBA16UI:210format = Image::FORMAT_RGBA16I;211break;212case GL_COMPRESSED_RGB_S3TC_DXT1_EXT:213case GL_COMPRESSED_RGBA_S3TC_DXT1_EXT:214format = Image::FORMAT_DXT1;215break;216case GL_COMPRESSED_RGBA_S3TC_DXT3_EXT:217format = Image::FORMAT_DXT3;218break;219case GL_COMPRESSED_RGBA_S3TC_DXT5_EXT:220format = Image::FORMAT_DXT5;221break;222case GL_COMPRESSED_RED_RGTC1:223format = Image::FORMAT_RGTC_R;224break;225case GL_COMPRESSED_RG_RGTC2:226format = Image::FORMAT_RGTC_RG;227break;228case GL_COMPRESSED_RGB_BPTC_UNSIGNED_FLOAT:229format = Image::FORMAT_BPTC_RGBFU;230break;231case GL_COMPRESSED_RGBA_BPTC_UNORM:232format = Image::FORMAT_BPTC_RGBA;233break;234case GL_ETC1_RGB8_OES:235format = Image::FORMAT_ETC;236break;237case GL_COMPRESSED_R11_EAC:238format = Image::FORMAT_ETC2_R11;239break;240// Decompression is not supported for this format.241/*case GL_COMPRESSED_SIGNED_R11_EAC:242format = Image::FORMAT_ETC2_R11S;243break;*/244case GL_COMPRESSED_RG11_EAC:245format = Image::FORMAT_ETC2_RG11;246break;247// Decompression is not supported for this format.248/*case GL_COMPRESSED_SIGNED_RG11_EAC:249format = Image::FORMAT_ETC2_RG11S;250break;*/251case GL_COMPRESSED_RGB8_ETC2:252format = Image::FORMAT_ETC2_RGB8;253break;254case GL_COMPRESSED_RGBA8_ETC2_EAC:255format = Image::FORMAT_ETC2_RGBA8;256break;257// Decompression is not supported for this format.258/*case GL_COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2:259format = Image::FORMAT_ETC2_RGB8A1;260break;*/261case GL_COMPRESSED_SRGB8_ALPHA8_ASTC_4x4_KHR:262format = Image::FORMAT_ASTC_4x4;263break;264case GL_COMPRESSED_RGBA_ASTC_4x4_KHR:265format = Image::FORMAT_ASTC_4x4_HDR;266break;267case GL_COMPRESSED_SRGB8_ALPHA8_ASTC_8x8_KHR:268format = Image::FORMAT_ASTC_8x8;269break;270case GL_COMPRESSED_RGBA_ASTC_8x8_KHR:271format = Image::FORMAT_ASTC_8x8_HDR;272break;273default:274ktxTexture_Destroy(ktx_texture);275ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported format " + itos(((ktxTexture1 *)ktx_texture)->glInternalformat) + " of KTX1 texture file.");276}277break;278case ktxTexture2_c: {279ktxTexture2 *ktx_texture2 = reinterpret_cast<ktxTexture2 *>(ktx_texture);280if (ktx_texture2->vkFormat == VK_FORMAT_UNDEFINED) {281if (!ktxTexture2_NeedsTranscoding(ktx_texture2)) {282ktxTexture_Destroy(ktx_texture);283ERR_FAIL_V_MSG(Ref<Resource>(), "Invalid VK_FORMAT_UNDEFINED of KTX2 texture file.");284}285ktx_transcode_fmt_e ktxfmt;286switch (ktxTexture2_GetNumComponents(ktx_texture2)) {287case 1: {288if (ktxTexture2_GetOETF_e(ktx_texture2) == KHR_DF_TRANSFER_SRGB) { // TODO srgb native support289ktxfmt = KTX_TTF_RGBA32;290} else if (RS::get_singleton()->has_os_feature("rgtc")) {291ktxfmt = KTX_TTF_BC4_R;292} else {293ktxfmt = KTX_TTF_RGBA32;294}295break;296}297case 2: {298if (ktxTexture2_GetOETF_e(ktx_texture2) == KHR_DF_TRANSFER_SRGB) { // TODO srgb native support299ktxfmt = KTX_TTF_RGBA32;300} else if (RS::get_singleton()->has_os_feature("rgtc")) {301ktxfmt = KTX_TTF_BC5_RG;302} else {303ktxfmt = KTX_TTF_RGBA32;304}305break;306}307case 3: {308if (ktxTexture2_GetOETF_e(ktx_texture2) == KHR_DF_TRANSFER_SRGB) { // TODO: srgb native support309ktxfmt = KTX_TTF_RGBA32;310} else if (RS::get_singleton()->has_os_feature("bptc")) {311ktxfmt = KTX_TTF_BC7_RGBA;312} else if (RS::get_singleton()->has_os_feature("s3tc")) {313ktxfmt = KTX_TTF_BC1_RGB;314} else if (RS::get_singleton()->has_os_feature("etc2")) {315ktxfmt = KTX_TTF_ETC1_RGB;316} else {317ktxfmt = KTX_TTF_RGBA32;318}319break;320}321case 4: {322if (ktxTexture2_GetOETF_e(ktx_texture2) == KHR_DF_TRANSFER_SRGB) { // TODO srgb native support323ktxfmt = KTX_TTF_RGBA32;324} else if (RS::get_singleton()->has_os_feature("astc")) {325ktxfmt = KTX_TTF_ASTC_4x4_RGBA;326} else if (RS::get_singleton()->has_os_feature("bptc")) {327ktxfmt = KTX_TTF_BC7_RGBA;328} else if (RS::get_singleton()->has_os_feature("s3tc")) {329ktxfmt = KTX_TTF_BC3_RGBA;330} else if (RS::get_singleton()->has_os_feature("etc2")) {331ktxfmt = KTX_TTF_ETC2_RGBA;332} else {333ktxfmt = KTX_TTF_RGBA32;334}335break;336}337default: {338ktxTexture_Destroy(ktx_texture);339ERR_FAIL_V_MSG(Ref<Resource>(), "Invalid components of KTX2 texture file.");340}341}342result = ktxTexture2_TranscodeBasis(ktx_texture2, ktxfmt, 0);343if (result != KTX_SUCCESS) {344ktxTexture_Destroy(ktx_texture);345ERR_FAIL_V_MSG(Ref<Resource>(), "Failed to transcode KTX2 texture file.");346}347}348switch (ktx_texture2->vkFormat) {349case VK_FORMAT_R8_UNORM:350format = Image::FORMAT_L8;351break;352case VK_FORMAT_R8G8_UNORM:353format = Image::FORMAT_LA8;354break;355case VK_FORMAT_R8G8B8_SRGB:356format = Image::FORMAT_RGB8;357srgb = true;358break;359case VK_FORMAT_R8G8B8A8_SRGB:360format = Image::FORMAT_RGBA8;361srgb = true;362break;363case VK_FORMAT_R8_UINT:364format = Image::FORMAT_R8;365break;366case VK_FORMAT_R8G8_UINT:367format = Image::FORMAT_RG8;368break;369case VK_FORMAT_R8G8B8_UINT:370format = Image::FORMAT_RGB8;371break;372case VK_FORMAT_R8G8B8A8_UINT:373format = Image::FORMAT_RGBA8;374break;375case VK_FORMAT_R4G4B4A4_UNORM_PACK16:376format = Image::FORMAT_RGBA4444;377break;378case VK_FORMAT_R5G6B5_UNORM_PACK16:379format = Image::FORMAT_RGB565;380break;381case VK_FORMAT_R32_SFLOAT:382format = Image::FORMAT_RF;383break;384case VK_FORMAT_R32G32_SFLOAT:385format = Image::FORMAT_RGF;386break;387case VK_FORMAT_R32G32B32_SFLOAT:388format = Image::FORMAT_RGBF;389break;390case VK_FORMAT_R32G32B32A32_SFLOAT:391format = Image::FORMAT_RGBAF;392break;393case VK_FORMAT_R16_SFLOAT:394format = Image::FORMAT_RH;395break;396case VK_FORMAT_R16G16_SFLOAT:397format = Image::FORMAT_RGH;398break;399case VK_FORMAT_R16G16B16_SFLOAT:400format = Image::FORMAT_RGBH;401break;402case VK_FORMAT_R16G16B16A16_SFLOAT:403format = Image::FORMAT_RGBAH;404break;405case VK_FORMAT_E5B9G9R9_UFLOAT_PACK32:406format = Image::FORMAT_RGBE9995;407break;408case VK_FORMAT_R16_UNORM:409format = Image::FORMAT_R16;410break;411case VK_FORMAT_R16G16_UNORM:412format = Image::FORMAT_RG16;413break;414case VK_FORMAT_R16G16B16_UNORM:415format = Image::FORMAT_RGB16;416break;417case VK_FORMAT_R16G16B16A16_UNORM:418format = Image::FORMAT_RGBA16;419break;420case VK_FORMAT_R16_UINT:421format = Image::FORMAT_R16I;422break;423case VK_FORMAT_R16G16_UINT:424format = Image::FORMAT_RG16I;425break;426case VK_FORMAT_R16G16B16_UINT:427format = Image::FORMAT_RGB16I;428break;429case VK_FORMAT_R16G16B16A16_UINT:430format = Image::FORMAT_RGBA16I;431break;432case VK_FORMAT_BC1_RGB_UNORM_BLOCK:433case VK_FORMAT_BC1_RGBA_UNORM_BLOCK:434format = Image::FORMAT_DXT1;435break;436case VK_FORMAT_BC2_UNORM_BLOCK:437format = Image::FORMAT_DXT3;438break;439case VK_FORMAT_BC3_UNORM_BLOCK:440format = Image::FORMAT_DXT5;441break;442case VK_FORMAT_BC4_UNORM_BLOCK:443format = Image::FORMAT_RGTC_R;444break;445case VK_FORMAT_BC5_UNORM_BLOCK:446format = Image::FORMAT_RGTC_RG;447break;448case VK_FORMAT_BC6H_UFLOAT_BLOCK:449format = Image::FORMAT_BPTC_RGBFU;450break;451case VK_FORMAT_BC6H_SFLOAT_BLOCK:452format = Image::FORMAT_BPTC_RGBF;453break;454case VK_FORMAT_BC7_UNORM_BLOCK:455format = Image::FORMAT_BPTC_RGBA;456break;457case VK_FORMAT_EAC_R11_UNORM_BLOCK:458format = Image::FORMAT_ETC2_R11;459break;460// Decompression is not supported for this format.461/*case VK_FORMAT_EAC_R11_SNORM_BLOCK:462format = Image::FORMAT_ETC2_R11S;463break;*/464case VK_FORMAT_EAC_R11G11_UNORM_BLOCK:465format = Image::FORMAT_ETC2_RG11;466break;467// Decompression is not supported for this format.468/*case VK_FORMAT_EAC_R11G11_SNORM_BLOCK:469format = Image::FORMAT_ETC2_RG11S;470break;*/471case VK_FORMAT_ETC2_R8G8B8_UNORM_BLOCK:472format = Image::FORMAT_ETC2_RGB8;473break;474case VK_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK:475format = Image::FORMAT_ETC2_RGBA8;476break;477// Decompression is not supported for this format.478/*case VK_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK:479format = Image::FORMAT_ETC2_RGB8A1;480break;*/481case VK_FORMAT_ASTC_4x4_SRGB_BLOCK:482format = Image::FORMAT_ASTC_4x4;483break;484case VK_FORMAT_ASTC_4x4_UNORM_BLOCK:485format = Image::FORMAT_ASTC_4x4_HDR;486break;487case VK_FORMAT_ASTC_8x8_SRGB_BLOCK:488format = Image::FORMAT_ASTC_8x8;489break;490case VK_FORMAT_ASTC_8x8_UNORM_BLOCK:491format = Image::FORMAT_ASTC_8x8_HDR;492break;493default:494ktxTexture_Destroy(ktx_texture);495ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported format " + itos(((ktxTexture2 *)ktx_texture)->vkFormat) + " of KTX2 texture file.");496break;497}498break;499}500default:501ktxTexture_Destroy(ktx_texture);502ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported version KTX texture file.");503break;504}505506Vector<uint8_t> src_data;507508// KTX use 4-bytes padding, don't use mipmaps if padding is effective509// TODO: unpad dynamically510int pixel_size = Image::get_format_pixel_size(format);511int pixel_rshift = Image::get_format_pixel_rshift(format);512int block = Image::get_format_block_size(format);513int minw, minh;514Image::get_format_min_pixel_size(format, minw, minh);515int w = width;516int h = height;517for (uint32_t i = 0; i < mipmaps; ++i) {518ktx_size_t mip_size = ktxTexture_GetImageSize(ktx_texture, i);519size_t bw = w % block != 0 ? w + (block - w % block) : w;520size_t bh = h % block != 0 ? h + (block - h % block) : h;521size_t s = bw * bh;522s *= pixel_size;523s >>= pixel_rshift;524if (mip_size != static_cast<ktx_size_t>(s)) {525if (!i) {526ktxTexture_Destroy(ktx_texture);527ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported padded KTX texture file.");528}529mipmaps = 1;530break;531}532w = MAX(minw, w >> 1);533h = MAX(minh, h >> 1);534}535536for (uint32_t i = 0; i < mipmaps; ++i) {537ktx_size_t mip_size = ktxTexture_GetImageSize(ktx_texture, i);538ktx_size_t offset;539if (ktxTexture_GetImageOffset(ktx_texture, i, 0, 0, &offset) != KTX_SUCCESS) {540ktxTexture_Destroy(ktx_texture);541ERR_FAIL_V_MSG(Ref<Resource>(), "Invalid KTX texture file.");542}543int prev_size = src_data.size();544src_data.resize(prev_size + mip_size);545memcpy(src_data.ptrw() + prev_size, ktxTexture_GetData(ktx_texture) + offset, mip_size);546}547548Ref<Image> img = memnew(Image(width, height, mipmaps - 1, format, src_data));549if (srgb) {550img->srgb_to_linear();551}552553if (r_error) {554*r_error = OK;555}556557ktxTexture_Destroy(ktx_texture);558return img;559}560561Ref<Resource> ResourceFormatKTX::load(const String &p_path, const String &p_original_path, Error *r_error, bool p_use_sub_threads, float *r_progress, CacheMode p_cache_mode) {562if (r_error) {563*r_error = ERR_CANT_OPEN;564}565566Error err;567Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ, &err);568if (f.is_null()) {569return Ref<Resource>();570}571572Ref<FileAccess> fref(f);573if (r_error) {574*r_error = ERR_FILE_CORRUPT;575}576577ERR_FAIL_COND_V_MSG(err != OK, Ref<Resource>(), "Unable to open KTX texture file '" + p_path + "'.");578Ref<Image> img = load_from_file_access(f, r_error);579Ref<ImageTexture> texture = ImageTexture::create_from_image(img);580return texture;581}582583static Ref<Image> _ktx_mem_loader_func(const uint8_t *p_ktx, int p_size) {584Ref<FileAccessMemory> f;585f.instantiate();586f->open_custom(p_ktx, p_size);587Error err;588Ref<Image> img = load_from_file_access(f, &err);589ERR_FAIL_COND_V(err, Ref<Image>());590return img;591}592593void ResourceFormatKTX::get_recognized_extensions(List<String> *p_extensions) const {594p_extensions->push_back("ktx");595p_extensions->push_back("ktx2");596}597598bool ResourceFormatKTX::handles_type(const String &p_type) const {599return ClassDB::is_parent_class(p_type, "Texture2D");600}601602String ResourceFormatKTX::get_resource_type(const String &p_path) const {603if (p_path.get_extension().to_lower() == "ktx" || p_path.get_extension().to_lower() == "ktx2") {604return "ImageTexture";605}606return "";607}608609ResourceFormatKTX::ResourceFormatKTX() {610Image::_ktx_mem_loader_func = _ktx_mem_loader_func;611}612613614