Skip to content

Commit 74476b2

Browse files
beicausebeicause
committed
BasisU: Use KTX2 format and add project settings to configure encoder
1 parent a210fe6 commit 74476b2

File tree

4 files changed

+62
-26
lines changed

4 files changed

+62
-26
lines changed

‎doc/classes/ProjectSettings.xml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3196,6 +3196,27 @@
31963196
<member name="rendering/shading/overrides/force_vertex_shading" type="bool" setter="" getter="" default="false">
31973197
If [code]true[/code], forces vertex shading for all rendering. This can increase performance a lot, but also reduces quality immensely. Can be used to optimize performance on low-end mobile devices.
31983198
</member>
3199+
<member name="rendering/textures/basis_universal/quality_level" type="int" setter="" getter="" default="1">
3200+
If less than or equal to [code]0[/code], the quality will be automatically controlled. Otherwise, it controls the quality level, ranges from 1 to 255.
3201+
</member>
3202+
<member name="rendering/textures/basis_universal/rdo_dict_size" type="int" setter="" getter="" default="1024">
3203+
Specify the dict size for RDO, ranges from 64 to 65536.
3204+
</member>
3205+
<member name="rendering/textures/basis_universal/rdo_enabled" type="bool" setter="" getter="" default="false">
3206+
If [code]true[/code], enables Rate-Distortion Optimization (RDO) to reduce disk size.
3207+
</member>
3208+
<member name="rendering/textures/basis_universal/rdo_quality_scalar" type="float" setter="" getter="" default="1.0">
3209+
Specify the quality scalar for RDO, ranges from 0.001 to 50.0.
3210+
</member>
3211+
<member name="rendering/textures/basis_universal/uastc_pack_level" type="int" setter="" getter="" default="0">
3212+
Specify the UASTC pack level. Slower encoding speed improves quality.
3213+
</member>
3214+
<member name="rendering/textures/basis_universal/zstd_supercompression" type="bool" setter="" getter="" default="false">
3215+
If [code]true[/code], enables Zstandard supercompression to reduce disk size.
3216+
</member>
3217+
<member name="rendering/textures/basis_universal/zstd_supercompression_level" type="int" setter="" getter="" default="6">
3218+
Specify the compression level for Zstandard supercompression.
3219+
</member>
31993220
<member name="rendering/textures/canvas_textures/default_texture_filter" type="int" setter="" getter="" default="1">
32003221
The default texture filtering mode to use for [CanvasItem]s built-in texture. In shaders, this texture is accessed as [code]TEXTURE[/code].
32013222
[b]Note:[/b] For pixel art aesthetics, see also [member rendering/2d/snap/snap_2d_vertices_to_pixel] and [member rendering/2d/snap/snap_2d_transforms_to_pixel].

‎modules/basis_universal/SCsub

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,8 @@ env_thirdparty.disable_warnings()
5858
# <https://github.com/BinomialLLC/basis_universal/wiki/How-to-Use-and-Configure-the-Transcoder>
5959
env_thirdparty.Append(
6060
CPPDEFINES=[
61-
# Storage formats.
62-
# Godot only implements `.basis` support through basis_universal.
63-
# Support for `.ktx` files are implemented with a direct libktx implementation.
64-
# Building the encoder requires `BASISD_SUPPORT_KTX2` to be enabled,
65-
# so we can only disable Zstandard compression for `.ktx` files
66-
# (this is not used in `.basis` files).
67-
("BASISD_SUPPORT_KTX2_ZSTD", 0),
61+
# Enable ktx2 zstd_supercompression.
62+
("BASISD_SUPPORT_KTX2_ZSTD", 1),
6863
# GPU compression formats.
6964
("BASISD_SUPPORT_ATC", 0), # Proprietary Adreno format not supported by Godot.
7065
("BASISD_SUPPORT_FXT1", 0), # Legacy format not supported by Godot.

‎modules/basis_universal/image_compress_basisu.cpp

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030

3131
#include "image_compress_basisu.h"
3232

33+
#include "core/config/project_settings.h"
3334
#include "core/io/image.h"
3435
#include "core/os/os.h"
3536
#include "core/string/print_string.h"
@@ -100,14 +101,28 @@ Vector<uint8_t> basis_universal_packer(const Ref<Image> &p_image, Image::UsedCha
100101

101102
basisu::basis_compressor_params params;
102103

104+
int quality_level = GLOBAL_GET("rendering/textures/basis_universal/quality_level");
105+
int uastc_pack_level = GLOBAL_GET("rendering/textures/basis_universal/uastc_pack_level");
106+
bool rdo_enabled = GLOBAL_GET("rendering/textures/basis_universal/rdo_enabled");
107+
float rdo_quality_scalar = GLOBAL_GET("rendering/textures/basis_universal/rdo_quality_scalar");
108+
int rdo_dict_size = GLOBAL_GET("rendering/textures/basis_universal/rdo_dict_size");
109+
bool zstd_supercompression = GLOBAL_GET("rendering/textures/basis_universal/zstd_supercompression");
110+
int zstd_supercompression_level = GLOBAL_GET("rendering/textures/basis_universal/zstd_supercompression_level");
111+
112+
quality_level = CLAMP(quality_level, 0, 255);
113+
103114
params.m_uastc = true;
104-
params.m_quality_level = basisu::BASISU_QUALITY_MIN;
115+
params.m_quality_level = quality_level == 0 ? -1 : quality_level;
105116
params.m_pack_uastc_flags &= ~basisu::cPackUASTCLevelMask;
106-
params.m_pack_uastc_flags |= basisu::cPackUASTCLevelFastest;
117+
params.m_pack_uastc_flags |= uastc_pack_level;
107118

108-
params.m_rdo_uastc = 0.0f;
109-
params.m_rdo_uastc_quality_scalar = 0.0f;
110-
params.m_rdo_uastc_dict_size = 1024;
119+
params.m_rdo_uastc = rdo_enabled;
120+
params.m_rdo_uastc_quality_scalar = rdo_quality_scalar;
121+
params.m_rdo_uastc_dict_size = rdo_dict_size;
122+
123+
params.m_create_ktx2_file = true;
124+
params.m_ktx2_uastc_supercompression = zstd_supercompression ? basist::KTX2_SS_ZSTANDARD : basist::KTX2_SS_NONE;
125+
params.m_ktx2_zstd_supercompression_level = zstd_supercompression_level;
111126

112127
params.m_mip_fast = true;
113128
params.m_multithreading = true;
@@ -241,7 +256,7 @@ Vector<uint8_t> basis_universal_packer(const Ref<Image> &p_image, Image::UsedCha
241256
int basisu_err = compressor.process();
242257
ERR_FAIL_COND_V(basisu_err != basisu::basis_compressor::cECSuccess, Vector<uint8_t>());
243258

244-
const basisu::uint8_vec &basisu_encoded = compressor.get_output_basis_file();
259+
const basisu::uint8_vec &basisu_encoded = compressor.get_output_ktx2_file();
245260

246261
Vector<uint8_t> basisu_data;
247262
basisu_data.resize(basisu_encoded.size() + 4);
@@ -398,37 +413,34 @@ Ref<Image> basis_universal_unpacker_ptr(const uint8_t *p_data, int p_size) {
398413
src_ptr += 4;
399414
src_size -= 4;
400415

401-
basist::basisu_transcoder transcoder;
402-
ERR_FAIL_COND_V(!transcoder.validate_header(src_ptr, src_size), image);
403-
404-
transcoder.start_transcoding(src_ptr, src_size);
416+
basist::ktx2_transcoder transcoder;
417+
ERR_FAIL_COND_V(!transcoder.init(src_ptr, src_size), image);
405418

406-
basist::basisu_image_info basisu_info;
407-
transcoder.get_image_info(src_ptr, src_size, basisu_info, 0);
419+
transcoder.start_transcoding();
408420

409421
// Create the buffer for transcoded/decompressed data.
410422
Vector<uint8_t> out_data;
411-
out_data.resize(Image::get_image_data_size(basisu_info.m_width, basisu_info.m_height, image_format, basisu_info.m_total_levels > 1));
423+
out_data.resize(Image::get_image_data_size(transcoder.get_width(), transcoder.get_height(), image_format, transcoder.get_levels() > 1));
412424

413425
uint8_t *dst = out_data.ptrw();
414426
memset(dst, 0, out_data.size());
415427

416-
for (uint32_t i = 0; i < basisu_info.m_total_levels; i++) {
417-
basist::basisu_image_level_info basisu_level;
418-
transcoder.get_image_level_info(src_ptr, src_size, basisu_level, 0, i);
428+
for (uint32_t i = 0; i < transcoder.get_levels(); i++) {
429+
basist::ktx2_image_level_info basisu_level;
430+
transcoder.get_image_level_info(basisu_level, i, 0, 0);
419431

420432
uint32_t mip_block_or_pixel_count = Image::is_format_compressed(image_format) ? basisu_level.m_total_blocks : basisu_level.m_orig_width * basisu_level.m_orig_height;
421-
int64_t ofs = Image::get_image_mipmap_offset(basisu_info.m_width, basisu_info.m_height, image_format, i);
433+
int64_t ofs = Image::get_image_mipmap_offset(transcoder.get_width(), transcoder.get_height(), image_format, i);
422434

423-
bool result = transcoder.transcode_image_level(src_ptr, src_size, 0, i, dst + ofs, mip_block_or_pixel_count, basisu_format);
435+
bool result = transcoder.transcode_image_level(i, 0, 0, dst + ofs, mip_block_or_pixel_count, basisu_format);
424436

425437
if (!result) {
426438
print_line(vformat("BasisUniversal cannot unpack level %d.", i));
427439
break;
428440
}
429441
}
430442

431-
image = Image::create_from_data(basisu_info.m_width, basisu_info.m_height, basisu_info.m_total_levels > 1, image_format, out_data);
443+
image = Image::create_from_data(transcoder.get_width(), transcoder.get_height(), transcoder.get_levels() > 1, image_format, out_data);
432444

433445
if (needs_ra_rg_swap) {
434446
// Swap uncompressed RA-as-RG texture's color channels.

‎servers/rendering_server.cpp

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3597,6 +3597,14 @@ void RenderingServer::init() {
35973597
GLOBAL_DEF(PropertyInfo(Variant::INT, "rendering/textures/webp_compression/compression_method", PROPERTY_HINT_RANGE, "0,6,1"), 2);
35983598
GLOBAL_DEF(PropertyInfo(Variant::FLOAT, "rendering/textures/webp_compression/lossless_compression_factor", PROPERTY_HINT_RANGE, "0,100,1"), 25);
35993599

3600+
GLOBAL_DEF(PropertyInfo(Variant::INT, "rendering/textures/basis_universal/quality_level", PROPERTY_HINT_RANGE, "0,255,1"), 1);
3601+
GLOBAL_DEF(PropertyInfo(Variant::INT, "rendering/textures/basis_universal/uastc_pack_level", PROPERTY_HINT_ENUM, "Fastest,Faster,Medium,Slower,Slowest"), 0);
3602+
GLOBAL_DEF(PropertyInfo(Variant::BOOL, "rendering/textures/basis_universal/rdo_enabled"), false);
3603+
GLOBAL_DEF(PropertyInfo(Variant::FLOAT, "rendering/textures/basis_universal/rdo_quality_scalar", PROPERTY_HINT_RANGE, "0.001,50,0.001"), 1.0);
3604+
GLOBAL_DEF(PropertyInfo(Variant::INT, "rendering/textures/basis_universal/rdo_dict_size", PROPERTY_HINT_RANGE, "64,65536,1"), 1024);
3605+
GLOBAL_DEF(PropertyInfo(Variant::BOOL, "rendering/textures/basis_universal/zstd_supercompression"), false);
3606+
GLOBAL_DEF(PropertyInfo(Variant::INT, "rendering/textures/basis_universal/zstd_supercompression_level"), 6);
3607+
36003608
GLOBAL_DEF(PropertyInfo(Variant::FLOAT, "rendering/limits/time/time_rollover_secs", PROPERTY_HINT_RANGE, "1,10000,1,or_greater,suffix:s"), 3600);
36013609

36023610
GLOBAL_DEF_RST("rendering/lights_and_shadows/use_physical_light_units", false);

0 commit comments

Comments
 (0)