Path: blob/master/modules/ktx/texture_loader_ktx.cpp
20959 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"35#include "servers/rendering/rendering_server.h"3637#include <ktx.h>38#include <vk_format.h>3940KTX_error_code ktx_read(ktxStream *stream, void *dst, const ktx_size_t count) {41Ref<FileAccess> *f = reinterpret_cast<Ref<FileAccess> *>(stream->data.custom_ptr.address);42(*f)->get_buffer(reinterpret_cast<uint8_t *>(dst), count);43return KTX_SUCCESS;44}4546KTX_error_code ktx_skip(ktxStream *stream, const ktx_size_t count) {47Ref<FileAccess> *f = reinterpret_cast<Ref<FileAccess> *>(stream->data.custom_ptr.address);48for (ktx_size_t i = 0; i < count; ++i) {49(*f)->get_8();50}51return KTX_SUCCESS;52}5354KTX_error_code ktx_write(ktxStream *stream, const void *src, const ktx_size_t size, const ktx_size_t count) {55Ref<FileAccess> *f = reinterpret_cast<Ref<FileAccess> *>(stream->data.custom_ptr.address);56(*f)->store_buffer(reinterpret_cast<const uint8_t *>(src), size * count);57return KTX_SUCCESS;58}5960KTX_error_code ktx_getpos(ktxStream *stream, ktx_off_t *const offset) {61Ref<FileAccess> *f = reinterpret_cast<Ref<FileAccess> *>(stream->data.custom_ptr.address);62*offset = (*f)->get_position();63return KTX_SUCCESS;64}6566KTX_error_code ktx_setpos(ktxStream *stream, const ktx_off_t offset) {67Ref<FileAccess> *f = reinterpret_cast<Ref<FileAccess> *>(stream->data.custom_ptr.address);68(*f)->seek(offset);69return KTX_SUCCESS;70}7172KTX_error_code ktx_getsize(ktxStream *stream, ktx_size_t *const size) {73Ref<FileAccess> *f = reinterpret_cast<Ref<FileAccess> *>(stream->data.custom_ptr.address);74*size = (*f)->get_length();75return KTX_SUCCESS;76}7778void ktx_destruct(ktxStream *stream) {79(void)stream;80}8182static Ref<Image> load_from_file_access(Ref<FileAccess> f, Error *r_error) {83ktxStream ktx_stream;84ktx_stream.read = ktx_read;85ktx_stream.skip = ktx_skip;86ktx_stream.write = ktx_write;87ktx_stream.getpos = ktx_getpos;88ktx_stream.setpos = ktx_setpos;89ktx_stream.getsize = ktx_getsize;90ktx_stream.destruct = ktx_destruct;91ktx_stream.type = eStreamTypeCustom;92ktx_stream.data.custom_ptr.address = &f;93ktx_stream.data.custom_ptr.allocatorAddress = nullptr;94ktx_stream.data.custom_ptr.size = 0;95ktx_stream.readpos = 0;96ktx_stream.closeOnDestruct = false;97ktxTexture *ktx_texture;98KTX_error_code result = ktxTexture_CreateFromStream(&ktx_stream,99KTX_TEXTURE_CREATE_LOAD_IMAGE_DATA_BIT,100&ktx_texture);101if (result != KTX_SUCCESS) {102ERR_FAIL_V_MSG(Ref<Resource>(), "Invalid or unsupported KTX texture file.");103}104105if (ktx_texture->numDimensions != 2) {106ktxTexture_Destroy(ktx_texture);107ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported non-2D KTX texture file.");108}109110if (ktx_texture->isCubemap || ktx_texture->numFaces != 1) {111ktxTexture_Destroy(ktx_texture);112ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported cube map KTX texture file.");113}114115if (ktx_texture->isArray) {116ktxTexture_Destroy(ktx_texture);117ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported array KTX texture file.");118}119120uint32_t width = ktx_texture->baseWidth;121uint32_t height = ktx_texture->baseHeight;122uint32_t mipmaps = ktx_texture->numLevels;123Image::Format format;124bool srgb = false;125126switch (ktx_texture->classId) {127case ktxTexture1_c:128switch (((ktxTexture1 *)ktx_texture)->glInternalformat) {129case GL_LUMINANCE:130format = Image::FORMAT_L8;131break;132case GL_LUMINANCE_ALPHA:133format = Image::FORMAT_LA8;134break;135case GL_SRGB8:136format = Image::FORMAT_RGB8;137srgb = true;138break;139case GL_SRGB8_ALPHA8:140format = Image::FORMAT_RGBA8;141srgb = true;142break;143case GL_R8:144case GL_R8UI:145format = Image::FORMAT_R8;146break;147case GL_RG8:148format = Image::FORMAT_RG8;149break;150case GL_RGB8:151format = Image::FORMAT_RGB8;152break;153case GL_RGBA8:154format = Image::FORMAT_RGBA8;155break;156case GL_RGBA4:157format = Image::FORMAT_RGBA4444;158break;159case GL_RGB565:160format = Image::FORMAT_RGB565;161break;162case GL_R32F:163format = Image::FORMAT_RF;164break;165case GL_RG32F:166format = Image::FORMAT_RGF;167break;168case GL_RGB32F:169format = Image::FORMAT_RGBF;170break;171case GL_RGBA32F:172format = Image::FORMAT_RGBAF;173break;174case GL_R16F:175format = Image::FORMAT_RH;176break;177case GL_RG16F:178format = Image::FORMAT_RGH;179break;180case GL_RGB16F:181format = Image::FORMAT_RGBH;182break;183case GL_RGBA16F:184format = Image::FORMAT_RGBAH;185break;186case GL_RGB9_E5:187format = Image::FORMAT_RGBE9995;188break;189case GL_R16:190format = Image::FORMAT_R16;191break;192case GL_RG16:193format = Image::FORMAT_RG16;194break;195case GL_RGB16:196format = Image::FORMAT_RGB16;197break;198case GL_RGBA16:199format = Image::FORMAT_RGBA16;200break;201case GL_R16UI:202format = Image::FORMAT_R16I;203break;204case GL_RG16UI:205format = Image::FORMAT_RG16I;206break;207case GL_RGB16UI:208format = Image::FORMAT_RGB16I;209break;210case GL_RGBA16UI:211format = Image::FORMAT_RGBA16I;212break;213case GL_COMPRESSED_RGB_S3TC_DXT1_EXT:214case GL_COMPRESSED_RGBA_S3TC_DXT1_EXT:215format = Image::FORMAT_DXT1;216break;217case GL_COMPRESSED_RGBA_S3TC_DXT3_EXT:218format = Image::FORMAT_DXT3;219break;220case GL_COMPRESSED_RGBA_S3TC_DXT5_EXT:221format = Image::FORMAT_DXT5;222break;223case GL_COMPRESSED_RED_RGTC1:224format = Image::FORMAT_RGTC_R;225break;226case GL_COMPRESSED_RG_RGTC2:227format = Image::FORMAT_RGTC_RG;228break;229case GL_COMPRESSED_RGB_BPTC_UNSIGNED_FLOAT:230format = Image::FORMAT_BPTC_RGBFU;231break;232case GL_COMPRESSED_RGBA_BPTC_UNORM:233format = Image::FORMAT_BPTC_RGBA;234break;235case GL_ETC1_RGB8_OES:236format = Image::FORMAT_ETC;237break;238case GL_COMPRESSED_R11_EAC:239format = Image::FORMAT_ETC2_R11;240break;241// Decompression is not supported for this format.242/*case GL_COMPRESSED_SIGNED_R11_EAC:243format = Image::FORMAT_ETC2_R11S;244break;*/245case GL_COMPRESSED_RG11_EAC:246format = Image::FORMAT_ETC2_RG11;247break;248// Decompression is not supported for this format.249/*case GL_COMPRESSED_SIGNED_RG11_EAC:250format = Image::FORMAT_ETC2_RG11S;251break;*/252case GL_COMPRESSED_RGB8_ETC2:253format = Image::FORMAT_ETC2_RGB8;254break;255case GL_COMPRESSED_RGBA8_ETC2_EAC:256format = Image::FORMAT_ETC2_RGBA8;257break;258// Decompression is not supported for this format.259/*case GL_COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2:260format = Image::FORMAT_ETC2_RGB8A1;261break;*/262case GL_COMPRESSED_SRGB8_ALPHA8_ASTC_4x4_KHR:263format = Image::FORMAT_ASTC_4x4;264break;265case GL_COMPRESSED_RGBA_ASTC_4x4_KHR:266format = Image::FORMAT_ASTC_4x4_HDR;267break;268case GL_COMPRESSED_SRGB8_ALPHA8_ASTC_8x8_KHR:269format = Image::FORMAT_ASTC_8x8;270break;271case GL_COMPRESSED_RGBA_ASTC_8x8_KHR:272format = Image::FORMAT_ASTC_8x8_HDR;273break;274default:275ktxTexture_Destroy(ktx_texture);276ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported format " + itos(((ktxTexture1 *)ktx_texture)->glInternalformat) + " of KTX1 texture file.");277}278break;279case ktxTexture2_c: {280ktxTexture2 *ktx_texture2 = reinterpret_cast<ktxTexture2 *>(ktx_texture);281if (ktx_texture2->vkFormat == VK_FORMAT_UNDEFINED) {282if (!ktxTexture2_NeedsTranscoding(ktx_texture2)) {283ktxTexture_Destroy(ktx_texture);284ERR_FAIL_V_MSG(Ref<Resource>(), "Invalid VK_FORMAT_UNDEFINED of KTX2 texture file.");285}286ktx_transcode_fmt_e ktxfmt;287switch (ktxTexture2_GetNumComponents(ktx_texture2)) {288case 1: {289if (ktxTexture2_GetOETF_e(ktx_texture2) == KHR_DF_TRANSFER_SRGB) { // TODO srgb native support290ktxfmt = KTX_TTF_RGBA32;291} else if (RS::get_singleton()->has_os_feature("rgtc")) {292ktxfmt = KTX_TTF_BC4_R;293} else {294ktxfmt = KTX_TTF_RGBA32;295}296break;297}298case 2: {299if (ktxTexture2_GetOETF_e(ktx_texture2) == KHR_DF_TRANSFER_SRGB) { // TODO srgb native support300ktxfmt = KTX_TTF_RGBA32;301} else if (RS::get_singleton()->has_os_feature("rgtc")) {302ktxfmt = KTX_TTF_BC5_RG;303} else {304ktxfmt = KTX_TTF_RGBA32;305}306break;307}308case 3: {309if (ktxTexture2_GetOETF_e(ktx_texture2) == KHR_DF_TRANSFER_SRGB) { // TODO: srgb native support310ktxfmt = KTX_TTF_RGBA32;311} else if (RS::get_singleton()->has_os_feature("bptc")) {312ktxfmt = KTX_TTF_BC7_RGBA;313} else if (RS::get_singleton()->has_os_feature("s3tc")) {314ktxfmt = KTX_TTF_BC1_RGB;315} else if (RS::get_singleton()->has_os_feature("etc2")) {316ktxfmt = KTX_TTF_ETC1_RGB;317} else {318ktxfmt = KTX_TTF_RGBA32;319}320break;321}322case 4: {323if (ktxTexture2_GetOETF_e(ktx_texture2) == KHR_DF_TRANSFER_SRGB) { // TODO srgb native support324ktxfmt = KTX_TTF_RGBA32;325} else if (RS::get_singleton()->has_os_feature("astc")) {326ktxfmt = KTX_TTF_ASTC_4x4_RGBA;327} else if (RS::get_singleton()->has_os_feature("bptc")) {328ktxfmt = KTX_TTF_BC7_RGBA;329} else if (RS::get_singleton()->has_os_feature("s3tc")) {330ktxfmt = KTX_TTF_BC3_RGBA;331} else if (RS::get_singleton()->has_os_feature("etc2")) {332ktxfmt = KTX_TTF_ETC2_RGBA;333} else {334ktxfmt = KTX_TTF_RGBA32;335}336break;337}338default: {339ktxTexture_Destroy(ktx_texture);340ERR_FAIL_V_MSG(Ref<Resource>(), "Invalid components of KTX2 texture file.");341}342}343result = ktxTexture2_TranscodeBasis(ktx_texture2, ktxfmt, 0);344if (result != KTX_SUCCESS) {345ktxTexture_Destroy(ktx_texture);346ERR_FAIL_V_MSG(Ref<Resource>(), "Failed to transcode KTX2 texture file.");347}348}349switch (ktx_texture2->vkFormat) {350case VK_FORMAT_R8_UNORM:351format = Image::FORMAT_L8;352break;353case VK_FORMAT_R8G8_UNORM:354format = Image::FORMAT_LA8;355break;356case VK_FORMAT_R8G8B8_SRGB:357format = Image::FORMAT_RGB8;358srgb = true;359break;360case VK_FORMAT_R8G8B8A8_SRGB:361format = Image::FORMAT_RGBA8;362srgb = true;363break;364case VK_FORMAT_R8_UINT:365format = Image::FORMAT_R8;366break;367case VK_FORMAT_R8G8_UINT:368format = Image::FORMAT_RG8;369break;370case VK_FORMAT_R8G8B8_UINT:371format = Image::FORMAT_RGB8;372break;373case VK_FORMAT_R8G8B8A8_UINT:374format = Image::FORMAT_RGBA8;375break;376case VK_FORMAT_R4G4B4A4_UNORM_PACK16:377format = Image::FORMAT_RGBA4444;378break;379case VK_FORMAT_R5G6B5_UNORM_PACK16:380format = Image::FORMAT_RGB565;381break;382case VK_FORMAT_R32_SFLOAT:383format = Image::FORMAT_RF;384break;385case VK_FORMAT_R32G32_SFLOAT:386format = Image::FORMAT_RGF;387break;388case VK_FORMAT_R32G32B32_SFLOAT:389format = Image::FORMAT_RGBF;390break;391case VK_FORMAT_R32G32B32A32_SFLOAT:392format = Image::FORMAT_RGBAF;393break;394case VK_FORMAT_R16_SFLOAT:395format = Image::FORMAT_RH;396break;397case VK_FORMAT_R16G16_SFLOAT:398format = Image::FORMAT_RGH;399break;400case VK_FORMAT_R16G16B16_SFLOAT:401format = Image::FORMAT_RGBH;402break;403case VK_FORMAT_R16G16B16A16_SFLOAT:404format = Image::FORMAT_RGBAH;405break;406case VK_FORMAT_E5B9G9R9_UFLOAT_PACK32:407format = Image::FORMAT_RGBE9995;408break;409case VK_FORMAT_R16_UNORM:410format = Image::FORMAT_R16;411break;412case VK_FORMAT_R16G16_UNORM:413format = Image::FORMAT_RG16;414break;415case VK_FORMAT_R16G16B16_UNORM:416format = Image::FORMAT_RGB16;417break;418case VK_FORMAT_R16G16B16A16_UNORM:419format = Image::FORMAT_RGBA16;420break;421case VK_FORMAT_R16_UINT:422format = Image::FORMAT_R16I;423break;424case VK_FORMAT_R16G16_UINT:425format = Image::FORMAT_RG16I;426break;427case VK_FORMAT_R16G16B16_UINT:428format = Image::FORMAT_RGB16I;429break;430case VK_FORMAT_R16G16B16A16_UINT:431format = Image::FORMAT_RGBA16I;432break;433case VK_FORMAT_BC1_RGB_UNORM_BLOCK:434case VK_FORMAT_BC1_RGBA_UNORM_BLOCK:435format = Image::FORMAT_DXT1;436break;437case VK_FORMAT_BC2_UNORM_BLOCK:438format = Image::FORMAT_DXT3;439break;440case VK_FORMAT_BC3_UNORM_BLOCK:441format = Image::FORMAT_DXT5;442break;443case VK_FORMAT_BC4_UNORM_BLOCK:444format = Image::FORMAT_RGTC_R;445break;446case VK_FORMAT_BC5_UNORM_BLOCK:447format = Image::FORMAT_RGTC_RG;448break;449case VK_FORMAT_BC6H_UFLOAT_BLOCK:450format = Image::FORMAT_BPTC_RGBFU;451break;452case VK_FORMAT_BC6H_SFLOAT_BLOCK:453format = Image::FORMAT_BPTC_RGBF;454break;455case VK_FORMAT_BC7_UNORM_BLOCK:456format = Image::FORMAT_BPTC_RGBA;457break;458case VK_FORMAT_EAC_R11_UNORM_BLOCK:459format = Image::FORMAT_ETC2_R11;460break;461// Decompression is not supported for this format.462/*case VK_FORMAT_EAC_R11_SNORM_BLOCK:463format = Image::FORMAT_ETC2_R11S;464break;*/465case VK_FORMAT_EAC_R11G11_UNORM_BLOCK:466format = Image::FORMAT_ETC2_RG11;467break;468// Decompression is not supported for this format.469/*case VK_FORMAT_EAC_R11G11_SNORM_BLOCK:470format = Image::FORMAT_ETC2_RG11S;471break;*/472case VK_FORMAT_ETC2_R8G8B8_UNORM_BLOCK:473format = Image::FORMAT_ETC2_RGB8;474break;475case VK_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK:476format = Image::FORMAT_ETC2_RGBA8;477break;478// Decompression is not supported for this format.479/*case VK_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK:480format = Image::FORMAT_ETC2_RGB8A1;481break;*/482case VK_FORMAT_ASTC_4x4_SRGB_BLOCK:483format = Image::FORMAT_ASTC_4x4;484break;485case VK_FORMAT_ASTC_4x4_UNORM_BLOCK:486format = Image::FORMAT_ASTC_4x4_HDR;487break;488case VK_FORMAT_ASTC_8x8_SRGB_BLOCK:489format = Image::FORMAT_ASTC_8x8;490break;491case VK_FORMAT_ASTC_8x8_UNORM_BLOCK:492format = Image::FORMAT_ASTC_8x8_HDR;493break;494default:495ktxTexture_Destroy(ktx_texture);496ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported format " + itos(((ktxTexture2 *)ktx_texture)->vkFormat) + " of KTX2 texture file.");497break;498}499break;500}501default:502ktxTexture_Destroy(ktx_texture);503ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported version KTX texture file.");504break;505}506507Vector<uint8_t> src_data;508509// KTX use 4-bytes padding, don't use mipmaps if padding is effective510// TODO: unpad dynamically511int pixel_size = Image::get_format_pixel_size(format);512int pixel_rshift = Image::get_format_pixel_rshift(format);513int block = Image::get_format_block_size(format);514int minw, minh;515Image::get_format_min_pixel_size(format, minw, minh);516int w = width;517int h = height;518for (uint32_t i = 0; i < mipmaps; ++i) {519ktx_size_t mip_size = ktxTexture_GetImageSize(ktx_texture, i);520size_t bw = w % block != 0 ? w + (block - w % block) : w;521size_t bh = h % block != 0 ? h + (block - h % block) : h;522size_t s = bw * bh;523s *= pixel_size;524s >>= pixel_rshift;525if (mip_size != static_cast<ktx_size_t>(s)) {526if (!i) {527ktxTexture_Destroy(ktx_texture);528ERR_FAIL_V_MSG(Ref<Resource>(), "Unsupported padded KTX texture file.");529}530mipmaps = 1;531break;532}533w = MAX(minw, w >> 1);534h = MAX(minh, h >> 1);535}536537for (uint32_t i = 0; i < mipmaps; ++i) {538ktx_size_t mip_size = ktxTexture_GetImageSize(ktx_texture, i);539ktx_size_t offset;540if (ktxTexture_GetImageOffset(ktx_texture, i, 0, 0, &offset) != KTX_SUCCESS) {541ktxTexture_Destroy(ktx_texture);542ERR_FAIL_V_MSG(Ref<Resource>(), "Invalid KTX texture file.");543}544int prev_size = src_data.size();545src_data.resize(prev_size + mip_size);546memcpy(src_data.ptrw() + prev_size, ktxTexture_GetData(ktx_texture) + offset, mip_size);547}548549Ref<Image> img = memnew(Image(width, height, mipmaps - 1, format, src_data));550if (srgb) {551img->srgb_to_linear();552}553554if (r_error) {555*r_error = OK;556}557558ktxTexture_Destroy(ktx_texture);559return img;560}561562Ref<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) {563if (r_error) {564*r_error = ERR_CANT_OPEN;565}566567Error err;568Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ, &err);569if (f.is_null()) {570return Ref<Resource>();571}572573Ref<FileAccess> fref(f);574if (r_error) {575*r_error = ERR_FILE_CORRUPT;576}577578ERR_FAIL_COND_V_MSG(err != OK, Ref<Resource>(), "Unable to open KTX texture file '" + p_path + "'.");579Ref<Image> img = load_from_file_access(f, r_error);580Ref<ImageTexture> texture = ImageTexture::create_from_image(img);581return texture;582}583584static Ref<Image> _ktx_mem_loader_func(const uint8_t *p_ktx, int p_size) {585Ref<FileAccessMemory> f;586f.instantiate();587f->open_custom(p_ktx, p_size);588Error err;589Ref<Image> img = load_from_file_access(f, &err);590ERR_FAIL_COND_V(err, Ref<Image>());591return img;592}593594void ResourceFormatKTX::get_recognized_extensions(List<String> *p_extensions) const {595p_extensions->push_back("ktx");596p_extensions->push_back("ktx2");597}598599bool ResourceFormatKTX::handles_type(const String &p_type) const {600return ClassDB::is_parent_class(p_type, "Texture2D");601}602603String ResourceFormatKTX::get_resource_type(const String &p_path) const {604if (p_path.has_extension("ktx") || p_path.has_extension("ktx2")) {605return "ImageTexture";606}607return "";608}609610ResourceFormatKTX::ResourceFormatKTX() {611Image::_ktx_mem_loader_func = _ktx_mem_loader_func;612}613614615