2017-03-05 22:47:28 +08:00
/*************************************************************************/
/* resource_importer_texture.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
2017-08-27 20:16:55 +08:00
/* https://godotengine.org */
2017-03-05 22:47:28 +08:00
/*************************************************************************/
2021-01-02 03:13:46 +08:00
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
2017-03-05 22:47:28 +08:00
/* */
/* 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. */
/*************************************************************************/
2018-01-05 07:50:27 +08:00
2017-02-03 11:08:50 +08:00
# include "resource_importer_texture.h"
2017-03-05 22:47:28 +08:00
2018-09-12 00:13:45 +08:00
# include "core/io/config_file.h"
# include "core/io/image_loader.h"
2019-09-27 10:16:44 +08:00
# include "core/version.h"
2017-03-05 21:21:25 +08:00
# include "editor/editor_file_system.h"
2017-09-13 15:13:23 +08:00
# include "editor/editor_node.h"
2020-05-01 20:34:23 +08:00
void ResourceImporterTexture : : _texture_reimport_roughness ( const Ref < StreamTexture2D > & p_tex , const String & p_normal_path , RS : : TextureDetectRoughnessChannel p_channel ) {
2020-02-26 18:28:13 +08:00
MutexLock lock ( singleton - > mutex ) ;
2017-02-06 11:38:39 +08:00
StringName path = p_tex - > get_path ( ) ;
if ( ! singleton - > make_flags . has ( path ) ) {
2019-06-12 02:43:37 +08:00
singleton - > make_flags [ path ] = MakeInfo ( ) ;
2017-02-06 11:38:39 +08:00
}
2019-06-12 02:43:37 +08:00
singleton - > make_flags [ path ] . flags | = MAKE_ROUGHNESS_FLAG ;
singleton - > make_flags [ path ] . channel_for_roughness = p_channel ;
singleton - > make_flags [ path ] . normal_path_for_roughness = p_normal_path ;
2017-02-06 11:38:39 +08:00
}
2020-05-01 20:34:23 +08:00
void ResourceImporterTexture : : _texture_reimport_3d ( const Ref < StreamTexture2D > & p_tex ) {
2020-02-26 18:28:13 +08:00
MutexLock lock ( singleton - > mutex ) ;
2017-02-06 11:38:39 +08:00
StringName path = p_tex - > get_path ( ) ;
if ( ! singleton - > make_flags . has ( path ) ) {
2019-06-12 02:43:37 +08:00
singleton - > make_flags [ path ] = MakeInfo ( ) ;
2017-02-06 11:38:39 +08:00
}
2019-06-12 02:43:37 +08:00
singleton - > make_flags [ path ] . flags | = MAKE_3D_FLAG ;
2017-02-06 11:38:39 +08:00
}
2020-05-01 20:34:23 +08:00
void ResourceImporterTexture : : _texture_reimport_normal ( const Ref < StreamTexture2D > & p_tex ) {
2020-02-26 18:28:13 +08:00
MutexLock lock ( singleton - > mutex ) ;
2017-06-17 08:47:28 +08:00
StringName path = p_tex - > get_path ( ) ;
if ( ! singleton - > make_flags . has ( path ) ) {
2019-06-12 02:43:37 +08:00
singleton - > make_flags [ path ] = MakeInfo ( ) ;
2017-06-17 08:47:28 +08:00
}
2019-06-12 02:43:37 +08:00
singleton - > make_flags [ path ] . flags | = MAKE_NORMAL_FLAG ;
2017-06-17 08:47:28 +08:00
}
2017-02-06 11:38:39 +08:00
void ResourceImporterTexture : : update_imports ( ) {
if ( EditorFileSystem : : get_singleton ( ) - > is_scanning ( ) | | EditorFileSystem : : get_singleton ( ) - > is_importing ( ) ) {
2019-05-19 18:34:40 +08:00
return ; // do nothing for now
2017-02-06 11:38:39 +08:00
}
2020-02-26 18:28:13 +08:00
MutexLock lock ( mutex ) ;
2017-02-06 11:38:39 +08:00
Vector < String > to_reimport ;
2020-02-26 18:28:13 +08:00
{
2020-12-15 20:04:21 +08:00
if ( make_flags . is_empty ( ) ) {
2020-02-26 18:28:13 +08:00
return ;
}
2017-02-06 11:38:39 +08:00
2020-02-26 18:28:13 +08:00
for ( Map < StringName , MakeInfo > : : Element * E = make_flags . front ( ) ; E ; E = E - > next ( ) ) {
Ref < ConfigFile > cf ;
2021-06-18 06:03:09 +08:00
cf . instantiate ( ) ;
2020-02-26 18:28:13 +08:00
String src_path = String ( E - > key ( ) ) + " .import " ;
2017-02-06 11:38:39 +08:00
2020-02-26 18:28:13 +08:00
Error err = cf - > load ( src_path ) ;
ERR_CONTINUE ( err ! = OK ) ;
2019-06-12 02:43:37 +08:00
2020-02-26 18:28:13 +08:00
bool changed = false ;
2017-02-06 11:38:39 +08:00
2020-02-26 18:28:13 +08:00
if ( E - > get ( ) . flags & MAKE_NORMAL_FLAG & & int ( cf - > get_value ( " params " , " compress/normal_map " ) ) = = 0 ) {
cf - > set_value ( " params " , " compress/normal_map " , 1 ) ;
changed = true ;
}
2017-06-17 08:47:28 +08:00
2020-02-26 18:28:13 +08:00
if ( E - > get ( ) . flags & MAKE_ROUGHNESS_FLAG & & int ( cf - > get_value ( " params " , " roughness/mode " ) ) = = 0 ) {
cf - > set_value ( " params " , " roughness/mode " , E - > get ( ) . channel_for_roughness + 2 ) ;
cf - > set_value ( " params " , " roughness/src_normal " , E - > get ( ) . normal_path_for_roughness ) ;
changed = true ;
2019-09-27 10:16:44 +08:00
}
2017-02-06 11:38:39 +08:00
2020-02-26 18:28:13 +08:00
if ( E - > get ( ) . flags & MAKE_3D_FLAG & & bool ( cf - > get_value ( " params " , " detect_3d/compress_to " ) ) ) {
int compress_to = cf - > get_value ( " params " , " detect_3d/compress_to " ) ;
cf - > set_value ( " params " , " detect_3d/compress_to " , 0 ) ;
if ( compress_to = = 1 ) {
cf - > set_value ( " params " , " compress/mode " , COMPRESS_VRAM_COMPRESSED ) ;
} else if ( compress_to = = 2 ) {
cf - > set_value ( " params " , " compress/mode " , COMPRESS_BASIS_UNIVERSAL ) ;
}
cf - > set_value ( " params " , " mipmaps/generate " , true ) ;
changed = true ;
}
2017-02-06 11:38:39 +08:00
2020-02-26 18:28:13 +08:00
if ( changed ) {
cf - > save ( src_path ) ;
to_reimport . push_back ( E - > key ( ) ) ;
}
}
2017-02-06 11:38:39 +08:00
2020-02-26 18:28:13 +08:00
make_flags . clear ( ) ;
}
2017-02-06 11:38:39 +08:00
if ( to_reimport . size ( ) ) {
EditorFileSystem : : get_singleton ( ) - > reimport_files ( to_reimport ) ;
}
}
2017-02-01 20:45:45 +08:00
String ResourceImporterTexture : : get_importer_name ( ) const {
return " texture " ;
}
2017-03-05 23:44:50 +08:00
String ResourceImporterTexture : : get_visible_name ( ) const {
2019-06-12 02:43:37 +08:00
return " Texture2D " ;
2017-02-01 20:45:45 +08:00
}
2020-05-14 20:29:06 +08:00
2017-03-05 23:44:50 +08:00
void ResourceImporterTexture : : get_recognized_extensions ( List < String > * p_extensions ) const {
2017-02-01 20:45:45 +08:00
ImageLoader : : get_recognized_extensions ( p_extensions ) ;
}
2020-05-14 20:29:06 +08:00
2017-02-01 20:45:45 +08:00
String ResourceImporterTexture : : get_save_extension ( ) const {
return " stex " ;
}
2017-03-05 23:44:50 +08:00
String ResourceImporterTexture : : get_resource_type ( ) const {
2020-05-01 20:34:23 +08:00
return " StreamTexture2D " ;
2017-02-01 20:45:45 +08:00
}
2017-03-05 23:44:50 +08:00
bool ResourceImporterTexture : : get_option_visibility ( const String & p_option , const Map < StringName , Variant > & p_options ) const {
2017-04-26 23:49:08 +08:00
if ( p_option = = " compress/lossy_quality " ) {
int compress_mode = int ( p_options [ " compress/mode " ] ) ;
2019-09-27 10:16:44 +08:00
if ( compress_mode ! = COMPRESS_LOSSY & & compress_mode ! = COMPRESS_VRAM_COMPRESSED ) {
2017-04-26 23:49:08 +08:00
return false ;
}
2018-08-28 00:47:13 +08:00
} else if ( p_option = = " compress/hdr_mode " ) {
2018-08-23 06:31:12 +08:00
int compress_mode = int ( p_options [ " compress/mode " ] ) ;
2019-09-27 10:16:44 +08:00
if ( compress_mode < COMPRESS_VRAM_COMPRESSED ) {
2018-08-23 06:31:12 +08:00
return false ;
}
2019-09-27 10:16:44 +08:00
} else if ( p_option = = " mipmaps/limit " ) {
return p_options [ " mipmaps/generate " ] ;
2018-08-28 11:05:04 +08:00
} else if ( p_option = = " compress/bptc_ldr " ) {
int compress_mode = int ( p_options [ " compress/mode " ] ) ;
2019-09-27 10:16:44 +08:00
if ( compress_mode < COMPRESS_VRAM_COMPRESSED ) {
2018-08-28 11:05:04 +08:00
return false ;
}
2021-02-18 00:44:49 +08:00
if ( ! ProjectSettings : : get_singleton ( ) - > get ( " rendering/textures/vram_compression/import_bptc " ) ) {
2018-08-28 11:05:04 +08:00
return false ;
}
2017-04-26 23:49:08 +08:00
}
2017-02-01 20:45:45 +08:00
return true ;
}
int ResourceImporterTexture : : get_preset_count ( ) const {
2020-06-14 21:08:09 +08:00
return 3 ;
2017-02-01 20:45:45 +08:00
}
2020-05-14 20:29:06 +08:00
2017-02-01 20:45:45 +08:00
String ResourceImporterTexture : : get_preset_name ( int p_idx ) const {
2017-03-05 23:44:50 +08:00
static const char * preset_names [ ] = {
2020-06-14 21:08:09 +08:00
" 2D/3D (Auto-Detect) " ,
2017-02-01 20:45:45 +08:00
" 2D " ,
2020-06-14 21:08:09 +08:00
" 3D " ,
2017-02-01 20:45:45 +08:00
} ;
return preset_names [ p_idx ] ;
}
2017-03-05 23:44:50 +08:00
void ResourceImporterTexture : : get_import_options ( List < ImportOption > * r_options , int p_preset ) const {
2019-09-27 10:16:44 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : INT , " compress/mode " , PROPERTY_HINT_ENUM , " Lossless,Lossy,VRAM Compressed,VRAM Uncompressed,Basis Universal " , PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_UPDATE_ALL_IF_MODIFIED ) , p_preset = = PRESET_3D ? 2 : 0 ) ) ;
Variant: Added 64-bit packed arrays, renamed Variant::REAL to FLOAT.
- Renames PackedIntArray to PackedInt32Array.
- Renames PackedFloatArray to PackedFloat32Array.
- Adds PackedInt64Array and PackedFloat64Array.
- Renames Variant::REAL to Variant::FLOAT for consistency.
Packed arrays are for storing large amount of data and creating stuff like
meshes, buffers. textures, etc. Forcing them to be 64 is a huge waste of
memory. That said, many users requested the ability to have 64 bits packed
arrays for their games, so this is just an optional added type.
For Variant, the float datatype is always 64 bits, and exposed as `float`.
We still have `real_t` which is the datatype that can change from 32 to 64
bits depending on a compile flag (not entirely working right now, but that's
the idea). It affects math related datatypes and code only.
Neither Variant nor PackedArray make use of real_t, which is only intended
for math precision, so the term is removed from there to keep only float.
2020-02-25 02:20:53 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : FLOAT , " compress/lossy_quality " , PROPERTY_HINT_RANGE , " 0,1,0.01 " ) , 0.7 ) ) ;
2020-05-01 20:34:23 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : INT , " compress/hdr_compression " , PROPERTY_HINT_ENUM , " Disabled,Opaque Only,Always " ) , 1 ) ) ;
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : INT , " compress/bptc_ldr " , PROPERTY_HINT_ENUM , " Disabled,Enabled,RGBA Only " ) , 0 ) ) ;
2017-06-17 08:47:28 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : INT , " compress/normal_map " , PROPERTY_HINT_ENUM , " Detect,Enable,Disabled " ) , 0 ) ) ;
2019-06-12 02:43:37 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : INT , " compress/channel_pack " , PROPERTY_HINT_ENUM , " sRGB Friendly,Optimized " ) , 0 ) ) ;
2020-12-13 03:32:39 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : BOOL , " compress/streamed " ) , false ) ) ;
2019-09-27 10:16:44 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : BOOL , " mipmaps/generate " ) , ( p_preset = = PRESET_3D ? true : false ) ) ) ;
2019-09-27 20:05:22 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : INT , " mipmaps/limit " , PROPERTY_HINT_RANGE , " -1,256 " ) , - 1 ) ) ;
2019-06-12 02:43:37 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : INT , " roughness/mode " , PROPERTY_HINT_ENUM , " Detect,Disabled,Red,Green,Blue,Alpha,Gray " ) , 0 ) ) ;
2020-10-22 05:19:29 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : STRING , " roughness/src_normal " , PROPERTY_HINT_FILE , " *.bmp,*.dds,*.exr,*.jpeg,*.jpg,*.hdr,*.png,*.svg,*.svgz,*.tga,*.webp " ) , " " ) ) ;
2019-06-26 21:08:25 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : BOOL , " process/fix_alpha_border " ) , p_preset ! = PRESET_3D ) ) ;
2017-06-25 19:01:15 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : BOOL , " process/premult_alpha " ) , false ) ) ;
2020-06-01 01:27:29 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : BOOL , " process/normal_map_invert_y " ) , false ) ) ;
2019-06-27 02:11:52 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : BOOL , " process/HDR_as_SRGB " ) , false ) ) ;
2019-09-14 11:37:42 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : INT , " process/size_limit " , PROPERTY_HINT_RANGE , " 0,4096,1 " ) , 0 ) ) ;
2019-09-27 20:05:22 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : INT , " detect_3d/compress_to " , PROPERTY_HINT_ENUM , " Disabled,VRAM Compressed,Basis Universal " ) , ( p_preset = = PRESET_DETECT ) ? 1 : 0 ) ) ;
Variant: Added 64-bit packed arrays, renamed Variant::REAL to FLOAT.
- Renames PackedIntArray to PackedInt32Array.
- Renames PackedFloatArray to PackedFloat32Array.
- Adds PackedInt64Array and PackedFloat64Array.
- Renames Variant::REAL to Variant::FLOAT for consistency.
Packed arrays are for storing large amount of data and creating stuff like
meshes, buffers. textures, etc. Forcing them to be 64 is a huge waste of
memory. That said, many users requested the ability to have 64 bits packed
arrays for their games, so this is just an optional added type.
For Variant, the float datatype is always 64 bits, and exposed as `float`.
We still have `real_t` which is the datatype that can change from 32 to 64
bits depending on a compile flag (not entirely working right now, but that's
the idea). It affects math related datatypes and code only.
Neither Variant nor PackedArray make use of real_t, which is only intended
for math precision, so the term is removed from there to keep only float.
2020-02-25 02:20:53 +08:00
r_options - > push_back ( ImportOption ( PropertyInfo ( Variant : : FLOAT , " svg/scale " , PROPERTY_HINT_RANGE , " 0.001,100,0.001 " ) , 1.0 ) ) ;
2017-02-01 20:45:45 +08:00
}
2020-05-01 20:34:23 +08:00
void ResourceImporterTexture : : save_to_stex_format ( FileAccess * f , const Ref < Image > & p_image , CompressMode p_compress_mode , Image : : UsedChannels p_channels , Image : : CompressMode p_compress_format , float p_lossy_quality ) {
2017-02-01 20:45:45 +08:00
switch ( p_compress_mode ) {
case COMPRESS_LOSSLESS : {
2021-04-13 00:56:50 +08:00
bool lossless_force_png = ProjectSettings : : get_singleton ( ) - > get ( " rendering/textures/lossless_compression/force_png " ) ;
bool use_webp = ! lossless_force_png & & p_image - > get_width ( ) < = 16383 & & p_image - > get_height ( ) < = 16383 ; // WebP has a size limit
f - > store_32 ( use_webp ? StreamTexture2D : : DATA_FORMAT_WEBP : StreamTexture2D : : DATA_FORMAT_PNG ) ;
2019-09-27 10:16:44 +08:00
f - > store_16 ( p_image - > get_width ( ) ) ;
f - > store_16 ( p_image - > get_height ( ) ) ;
f - > store_32 ( p_image - > get_mipmap_count ( ) ) ;
f - > store_32 ( p_image - > get_format ( ) ) ;
2017-02-01 20:45:45 +08:00
2019-09-27 10:16:44 +08:00
for ( int i = 0 ; i < p_image - > get_mipmap_count ( ) + 1 ; i + + ) {
2021-04-13 00:56:50 +08:00
Vector < uint8_t > data ;
if ( use_webp ) {
data = Image : : webp_lossless_packer ( p_image - > get_image_from_mipmap ( i ) ) ;
} else {
data = Image : : png_packer ( p_image - > get_image_from_mipmap ( i ) ) ;
}
2017-02-01 20:45:45 +08:00
int data_len = data . size ( ) ;
f - > store_32 ( data_len ) ;
2020-02-18 05:06:54 +08:00
const uint8_t * r = data . ptr ( ) ;
f - > store_buffer ( r , data_len ) ;
2017-02-01 20:45:45 +08:00
}
} break ;
case COMPRESS_LOSSY : {
2021-04-13 00:56:50 +08:00
f - > store_32 ( StreamTexture2D : : DATA_FORMAT_WEBP ) ;
2019-09-27 10:16:44 +08:00
f - > store_16 ( p_image - > get_width ( ) ) ;
f - > store_16 ( p_image - > get_height ( ) ) ;
f - > store_32 ( p_image - > get_mipmap_count ( ) ) ;
f - > store_32 ( p_image - > get_format ( ) ) ;
2017-02-01 20:45:45 +08:00
2019-09-27 10:16:44 +08:00
for ( int i = 0 ; i < p_image - > get_mipmap_count ( ) + 1 ; i + + ) {
2021-04-13 00:56:50 +08:00
Vector < uint8_t > data = Image : : webp_lossy_packer ( p_image - > get_image_from_mipmap ( i ) , p_lossy_quality ) ;
2017-02-01 20:45:45 +08:00
int data_len = data . size ( ) ;
f - > store_32 ( data_len ) ;
2020-02-18 05:06:54 +08:00
const uint8_t * r = data . ptr ( ) ;
f - > store_buffer ( r , data_len ) ;
2017-02-01 20:45:45 +08:00
}
} break ;
2019-09-27 10:16:44 +08:00
case COMPRESS_VRAM_COMPRESSED : {
2017-05-17 18:36:47 +08:00
Ref < Image > image = p_image - > duplicate ( ) ;
2017-05-27 08:49:49 +08:00
2020-05-01 20:34:23 +08:00
image - > compress_from_channels ( p_compress_format , p_channels , p_lossy_quality ) ;
2017-02-01 20:45:45 +08:00
2020-05-01 20:34:23 +08:00
f - > store_32 ( StreamTexture2D : : DATA_FORMAT_IMAGE ) ;
2019-09-27 10:16:44 +08:00
f - > store_16 ( image - > get_width ( ) ) ;
f - > store_16 ( image - > get_height ( ) ) ;
f - > store_32 ( image - > get_mipmap_count ( ) ) ;
f - > store_32 ( image - > get_format ( ) ) ;
2017-02-01 20:45:45 +08:00
2020-02-18 05:06:54 +08:00
Vector < uint8_t > data = image - > get_data ( ) ;
2017-02-01 20:45:45 +08:00
int dl = data . size ( ) ;
2020-02-18 05:06:54 +08:00
const uint8_t * r = data . ptr ( ) ;
f - > store_buffer ( r , dl ) ;
2017-02-01 20:45:45 +08:00
} break ;
2019-09-27 10:16:44 +08:00
case COMPRESS_VRAM_UNCOMPRESSED : {
2020-05-01 20:34:23 +08:00
f - > store_32 ( StreamTexture2D : : DATA_FORMAT_IMAGE ) ;
2019-09-27 10:16:44 +08:00
f - > store_16 ( p_image - > get_width ( ) ) ;
f - > store_16 ( p_image - > get_height ( ) ) ;
f - > store_32 ( p_image - > get_mipmap_count ( ) ) ;
f - > store_32 ( p_image - > get_format ( ) ) ;
2017-02-01 20:45:45 +08:00
2020-02-18 05:06:54 +08:00
Vector < uint8_t > data = p_image - > get_data ( ) ;
2017-02-01 20:45:45 +08:00
int dl = data . size ( ) ;
2020-02-18 05:06:54 +08:00
const uint8_t * r = data . ptr ( ) ;
2017-02-01 20:45:45 +08:00
2020-02-18 05:06:54 +08:00
f - > store_buffer ( r , dl ) ;
2017-02-01 20:45:45 +08:00
} break ;
2019-09-27 10:16:44 +08:00
case COMPRESS_BASIS_UNIVERSAL : {
2020-05-01 20:34:23 +08:00
f - > store_32 ( StreamTexture2D : : DATA_FORMAT_BASIS_UNIVERSAL ) ;
2019-09-27 10:16:44 +08:00
f - > store_16 ( p_image - > get_width ( ) ) ;
f - > store_16 ( p_image - > get_height ( ) ) ;
f - > store_32 ( p_image - > get_mipmap_count ( ) ) ;
f - > store_32 ( p_image - > get_format ( ) ) ;
for ( int i = 0 ; i < p_image - > get_mipmap_count ( ) + 1 ; i + + ) {
2020-02-18 05:06:54 +08:00
Vector < uint8_t > data = Image : : basis_universal_packer ( p_image - > get_image_from_mipmap ( i ) , p_channels ) ;
2019-09-27 10:16:44 +08:00
int data_len = data . size ( ) ;
f - > store_32 ( data_len ) ;
2020-02-18 05:06:54 +08:00
const uint8_t * r = data . ptr ( ) ;
f - > store_buffer ( r , data_len ) ;
2019-09-27 10:16:44 +08:00
}
} break ;
2017-02-01 20:45:45 +08:00
}
2019-09-27 10:16:44 +08:00
}
2020-05-01 20:34:23 +08:00
void ResourceImporterTexture : : _save_stex ( const Ref < Image > & p_image , const String & p_to_path , CompressMode p_compress_mode , float p_lossy_quality , Image : : CompressMode p_vram_compression , bool p_mipmaps , bool p_streamable , bool p_detect_3d , bool p_detect_roughness , bool p_detect_normal , bool p_force_normal , bool p_srgb_friendly , bool p_force_po2_for_compressed , uint32_t p_limit_mipmap , const Ref < Image > & p_normal , Image : : RoughnessChannel p_roughness_channel ) {
2019-09-27 10:16:44 +08:00
FileAccess * f = FileAccess : : open ( p_to_path , FileAccess : : WRITE ) ;
2021-06-17 07:13:36 +08:00
ERR_FAIL_NULL ( f ) ;
2019-09-27 10:16:44 +08:00
f - > store_8 ( ' G ' ) ;
f - > store_8 ( ' S ' ) ;
f - > store_8 ( ' T ' ) ;
f - > store_8 ( ' 2 ' ) ; //godot streamable texture 2D
//format version
2020-05-01 20:34:23 +08:00
f - > store_32 ( StreamTexture2D : : FORMAT_VERSION ) ;
2019-09-27 10:16:44 +08:00
//texture may be resized later, so original size must be saved first
f - > store_32 ( p_image - > get_width ( ) ) ;
f - > store_32 ( p_image - > get_height ( ) ) ;
uint32_t flags = 0 ;
2020-05-14 22:41:43 +08:00
if ( p_streamable ) {
2020-05-01 20:34:23 +08:00
flags | = StreamTexture2D : : FORMAT_BIT_STREAM ;
2020-05-14 22:41:43 +08:00
}
if ( p_mipmaps ) {
2020-05-01 20:34:23 +08:00
flags | = StreamTexture2D : : FORMAT_BIT_HAS_MIPMAPS ; //mipmaps bit
2020-05-14 22:41:43 +08:00
}
if ( p_detect_3d ) {
2020-05-01 20:34:23 +08:00
flags | = StreamTexture2D : : FORMAT_BIT_DETECT_3D ;
2020-05-14 22:41:43 +08:00
}
if ( p_detect_roughness ) {
2020-05-01 20:34:23 +08:00
flags | = StreamTexture2D : : FORMAT_BIT_DETECT_ROUGNESS ;
2020-05-14 22:41:43 +08:00
}
if ( p_detect_normal ) {
2020-05-01 20:34:23 +08:00
flags | = StreamTexture2D : : FORMAT_BIT_DETECT_NORMAL ;
2020-05-14 22:41:43 +08:00
}
2019-09-27 10:16:44 +08:00
f - > store_32 ( flags ) ;
f - > store_32 ( p_limit_mipmap ) ;
2020-03-12 01:59:18 +08:00
//reserved for future use
2019-09-27 10:16:44 +08:00
f - > store_32 ( 0 ) ;
f - > store_32 ( 0 ) ;
f - > store_32 ( 0 ) ;
/*
print_line ( " streamable " + itos ( p_streamable ) ) ;
print_line ( " mipmaps " + itos ( p_mipmaps ) ) ;
print_line ( " detect_3d " + itos ( p_detect_3d ) ) ;
print_line ( " roughness " + itos ( p_detect_roughness ) ) ;
print_line ( " normal " + itos ( p_detect_normal ) ) ;
*/
if ( ( p_compress_mode = = COMPRESS_LOSSLESS | | p_compress_mode = = COMPRESS_LOSSY ) & & p_image - > get_format ( ) > Image : : FORMAT_RGBA8 ) {
p_compress_mode = COMPRESS_VRAM_UNCOMPRESSED ; //these can't go as lossy
}
Ref < Image > image = p_image - > duplicate ( ) ;
if ( ( ( p_compress_mode = = COMPRESS_BASIS_UNIVERSAL ) | | ( p_compress_mode = = COMPRESS_VRAM_COMPRESSED & & p_force_po2_for_compressed ) ) & & p_mipmaps ) {
image - > resize_to_po2 ( ) ;
}
if ( p_mipmaps & & ( ! image - > has_mipmaps ( ) | | p_force_normal ) ) {
image - > generate_mipmaps ( p_force_normal ) ;
}
if ( ! p_mipmaps ) {
image - > clear_mipmaps ( ) ;
}
2020-01-27 07:09:40 +08:00
if ( image - > has_mipmaps ( ) & & p_normal . is_valid ( ) ) {
image - > generate_mipmap_roughness ( p_roughness_channel , p_normal ) ;
}
2019-09-27 10:16:44 +08:00
Image : : CompressSource csource = Image : : COMPRESS_SOURCE_GENERIC ;
if ( p_force_normal ) {
csource = Image : : COMPRESS_SOURCE_NORMAL ;
} else if ( p_srgb_friendly ) {
csource = Image : : COMPRESS_SOURCE_SRGB ;
}
Image : : UsedChannels used_channels = image - > detect_used_channels ( csource ) ;
2020-05-01 20:34:23 +08:00
save_to_stex_format ( f , image , p_compress_mode , used_channels , p_vram_compression , p_lossy_quality ) ;
2017-02-01 20:45:45 +08:00
memdelete ( f ) ;
}
2019-02-27 05:43:37 +08:00
Error ResourceImporterTexture : : import ( const String & p_source_file , const String & p_save_path , const Map < StringName , Variant > & p_options , List < String > * r_platform_variants , List < String > * r_gen_files , Variant * r_metadata ) {
2019-09-27 10:16:44 +08:00
CompressMode compress_mode = CompressMode ( int ( p_options [ " compress/mode " ] ) ) ;
2017-03-05 23:44:50 +08:00
float lossy = p_options [ " compress/lossy_quality " ] ;
2019-06-12 02:43:37 +08:00
int pack_channels = p_options [ " compress/channel_pack " ] ;
2019-09-27 10:16:44 +08:00
bool mipmaps = p_options [ " mipmaps/generate " ] ;
uint32_t mipmap_limit = int ( mipmaps ? int ( p_options [ " mipmaps/limit " ] ) : int ( - 1 ) ) ;
2017-03-05 23:44:50 +08:00
bool fix_alpha_border = p_options [ " process/fix_alpha_border " ] ;
bool premult_alpha = p_options [ " process/premult_alpha " ] ;
2020-06-01 01:27:29 +08:00
bool normal_map_invert_y = p_options [ " process/normal_map_invert_y " ] ;
2019-09-27 10:16:44 +08:00
bool stream = p_options [ " compress/streamed " ] ;
2019-09-14 11:37:42 +08:00
int size_limit = p_options [ " process/size_limit " ] ;
2017-05-30 09:11:33 +08:00
bool hdr_as_srgb = p_options [ " process/HDR_as_SRGB " ] ;
2017-06-17 08:47:28 +08:00
int normal = p_options [ " compress/normal_map " ] ;
2017-09-01 00:52:07 +08:00
float scale = p_options [ " svg/scale " ] ;
2020-05-01 20:34:23 +08:00
int hdr_compression = p_options [ " compress/hdr_compression " ] ;
2018-08-28 11:05:04 +08:00
int bptc_ldr = p_options [ " compress/bptc_ldr " ] ;
2019-06-12 02:43:37 +08:00
int roughness = p_options [ " roughness/mode " ] ;
2020-01-27 07:09:40 +08:00
String normal_map = p_options [ " roughness/src_normal " ] ;
Ref < Image > normal_image ;
2020-03-31 19:50:25 +08:00
Image : : RoughnessChannel roughness_channel = Image : : ROUGHNESS_CHANNEL_R ;
2017-02-01 20:45:45 +08:00
2020-01-27 07:09:40 +08:00
if ( mipmaps & & roughness > 1 & & FileAccess : : exists ( normal_map ) ) {
2021-06-18 06:03:09 +08:00
normal_image . instantiate ( ) ;
2020-01-27 07:09:40 +08:00
if ( ImageLoader : : load_image ( normal_map , normal_image ) = = OK ) {
roughness_channel = Image : : RoughnessChannel ( roughness - 2 ) ;
}
}
2017-05-17 18:36:47 +08:00
Ref < Image > image ;
2021-06-18 06:03:09 +08:00
image . instantiate ( ) ;
2020-04-02 07:20:12 +08:00
Error err = ImageLoader : : load_image ( p_source_file , image , nullptr , hdr_as_srgb , scale ) ;
2020-05-14 22:41:43 +08:00
if ( err ! = OK ) {
2017-02-01 20:45:45 +08:00
return err ;
2020-05-14 22:41:43 +08:00
}
2017-02-01 20:45:45 +08:00
2019-02-27 05:43:37 +08:00
Array formats_imported ;
2017-05-17 18:36:47 +08:00
if ( size_limit > 0 & & ( image - > get_width ( ) > size_limit | | image - > get_height ( ) > size_limit ) ) {
2017-02-01 20:45:45 +08:00
//limit size
2017-05-17 18:36:47 +08:00
if ( image - > get_width ( ) > = image - > get_height ( ) ) {
2017-02-01 20:45:45 +08:00
int new_width = size_limit ;
2017-05-17 18:36:47 +08:00
int new_height = image - > get_height ( ) * new_width / image - > get_width ( ) ;
2017-02-01 20:45:45 +08:00
2017-05-17 18:36:47 +08:00
image - > resize ( new_width , new_height , Image : : INTERPOLATE_CUBIC ) ;
2017-02-01 20:45:45 +08:00
} else {
int new_height = size_limit ;
2017-05-17 18:36:47 +08:00
int new_width = image - > get_width ( ) * new_height / image - > get_height ( ) ;
2017-02-01 20:45:45 +08:00
2017-05-17 18:36:47 +08:00
image - > resize ( new_width , new_height , Image : : INTERPOLATE_CUBIC ) ;
2017-02-01 20:45:45 +08:00
}
2018-07-03 21:55:50 +08:00
2018-11-26 04:05:35 +08:00
if ( normal = = 1 ) {
2018-07-03 21:55:50 +08:00
image - > normalize ( ) ;
}
2017-02-01 20:45:45 +08:00
}
if ( fix_alpha_border ) {
2017-05-17 18:36:47 +08:00
image - > fix_alpha_edges ( ) ;
2017-02-01 20:45:45 +08:00
}
if ( premult_alpha ) {
2017-05-17 18:36:47 +08:00
image - > premultiply_alpha ( ) ;
2017-02-01 20:45:45 +08:00
}
2020-06-01 01:27:29 +08:00
if ( normal_map_invert_y ) {
// Inverting the green channel can be used to flip a normal map's direction.
// There's no standard when it comes to normal map Y direction, so this is
// sometimes needed when using a normal map exported from another program.
// See <http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates>.
const int height = image - > get_height ( ) ;
const int width = image - > get_width ( ) ;
2018-08-18 00:28:07 +08:00
2018-09-02 21:13:19 +08:00
for ( int i = 0 ; i < width ; i + + ) {
for ( int j = 0 ; j < height ; j + + ) {
2020-06-01 01:27:29 +08:00
const Color color = image - > get_pixel ( i , j ) ;
image - > set_pixel ( i , j , Color ( color . r , 1 - color . g , color . b ) ) ;
2018-08-18 00:28:07 +08:00
}
}
}
2019-09-27 10:16:44 +08:00
if ( compress_mode = = COMPRESS_BASIS_UNIVERSAL & & image - > get_format ( ) > = Image : : FORMAT_RF ) {
//basis universal does not support float formats, fall back
compress_mode = COMPRESS_VRAM_COMPRESSED ;
}
bool detect_3d = int ( p_options [ " detect_3d/compress_to " ] ) > 0 ;
2019-06-12 02:43:37 +08:00
bool detect_roughness = roughness = = 0 ;
2017-06-17 08:47:28 +08:00
bool detect_normal = normal = = 0 ;
bool force_normal = normal = = 1 ;
2019-06-12 02:43:37 +08:00
bool srgb_friendly_pack = pack_channels = = 0 ;
2017-02-01 20:45:45 +08:00
2019-09-27 10:16:44 +08:00
if ( compress_mode = = COMPRESS_VRAM_COMPRESSED ) {
2017-07-20 04:00:46 +08:00
//must import in all formats, in order of priority (so platform choses the best supported one. IE, etc2 over etc).
2017-02-01 20:45:45 +08:00
//Android, GLES 2.x
2017-09-06 07:17:26 +08:00
2017-09-13 15:13:23 +08:00
bool ok_on_pc = false ;
2018-08-28 11:05:04 +08:00
bool is_hdr = ( image - > get_format ( ) > = Image : : FORMAT_RF & & image - > get_format ( ) < = Image : : FORMAT_RGBE9995 ) ;
2019-09-27 10:16:44 +08:00
bool is_ldr = ( image - > get_format ( ) > = Image : : FORMAT_L8 & & image - > get_format ( ) < = Image : : FORMAT_RGB565 ) ;
2021-02-18 00:44:49 +08:00
bool can_bptc = ProjectSettings : : get_singleton ( ) - > get ( " rendering/textures/vram_compression/import_bptc " ) ;
bool can_s3tc = ProjectSettings : : get_singleton ( ) - > get ( " rendering/textures/vram_compression/import_s3tc " ) ;
2017-09-06 07:17:26 +08:00
2018-08-28 00:47:13 +08:00
if ( can_bptc ) {
2020-05-01 20:34:23 +08:00
//add to the list anyway
formats_imported . push_back ( " bptc " ) ;
}
2018-08-28 11:05:04 +08:00
2020-05-01 20:34:23 +08:00
bool can_compress_hdr = hdr_compression > 0 ;
bool has_alpha = image - > detect_alpha ( ) ! = Image : : ALPHA_NONE ;
if ( is_hdr & & can_compress_hdr ) {
if ( has_alpha ) {
//can compress hdr, but hdr with alpha is not compressible
if ( hdr_compression = = 2 ) {
//but user selected to compress hdr anyway, so force an alpha-less format.
if ( image - > get_format ( ) = = Image : : FORMAT_RGBAF ) {
image - > convert ( Image : : FORMAT_RGBF ) ;
} else if ( image - > get_format ( ) = = Image : : FORMAT_RGBAH ) {
image - > convert ( Image : : FORMAT_RGBH ) ;
}
} else {
can_compress_hdr = false ;
2018-08-28 11:05:04 +08:00
}
2020-05-01 20:34:23 +08:00
}
2018-08-28 11:05:04 +08:00
2020-05-01 20:34:23 +08:00
if ( can_compress_hdr ) {
if ( ! can_bptc ) {
//fallback to RGBE99995
if ( image - > get_format ( ) ! = Image : : FORMAT_RGBE9995 ) {
image - > convert ( Image : : FORMAT_RGBE9995 ) ;
}
2018-08-28 11:05:04 +08:00
}
2020-05-01 20:34:23 +08:00
} else {
can_bptc = false ;
2018-08-22 10:56:04 +08:00
}
}
2020-05-01 20:34:23 +08:00
if ( is_ldr & & can_bptc ) {
if ( bptc_ldr = = 0 | | ( bptc_ldr = = 1 & & ! has_alpha ) ) {
can_bptc = false ;
}
2018-08-28 11:05:04 +08:00
}
2018-08-22 10:56:04 +08:00
2018-08-28 11:05:04 +08:00
if ( can_bptc | | can_s3tc ) {
2020-05-01 20:34:23 +08:00
_save_stex ( image , p_save_path + " .s3tc.stex " , compress_mode , lossy , can_bptc ? Image : : COMPRESS_BPTC : Image : : COMPRESS_S3TC , mipmaps , stream , detect_3d , detect_roughness , detect_normal , force_normal , srgb_friendly_pack , false , mipmap_limit , normal_image , roughness_channel ) ;
2017-06-17 08:47:28 +08:00
r_platform_variants - > push_back ( " s3tc " ) ;
2019-02-27 05:43:37 +08:00
formats_imported . push_back ( " s3tc " ) ;
2017-09-13 15:13:23 +08:00
ok_on_pc = true ;
2017-06-17 08:47:28 +08:00
}
2021-02-18 00:44:49 +08:00
if ( ProjectSettings : : get_singleton ( ) - > get ( " rendering/textures/vram_compression/import_etc2 " ) ) {
2020-05-01 20:34:23 +08:00
_save_stex ( image , p_save_path + " .etc2.stex " , compress_mode , lossy , Image : : COMPRESS_ETC2 , mipmaps , stream , detect_3d , detect_roughness , detect_normal , force_normal , srgb_friendly_pack , true , mipmap_limit , normal_image , roughness_channel ) ;
2017-06-17 08:47:28 +08:00
r_platform_variants - > push_back ( " etc2 " ) ;
2019-02-27 05:43:37 +08:00
formats_imported . push_back ( " etc2 " ) ;
2017-06-17 08:47:28 +08:00
}
2021-02-18 00:44:49 +08:00
if ( ProjectSettings : : get_singleton ( ) - > get ( " rendering/textures/vram_compression/import_etc " ) ) {
2020-05-01 20:34:23 +08:00
_save_stex ( image , p_save_path + " .etc.stex " , compress_mode , lossy , Image : : COMPRESS_ETC , mipmaps , stream , detect_3d , detect_roughness , detect_normal , force_normal , srgb_friendly_pack , true , mipmap_limit , normal_image , roughness_channel ) ;
2017-07-20 04:00:46 +08:00
r_platform_variants - > push_back ( " etc " ) ;
2019-02-27 05:43:37 +08:00
formats_imported . push_back ( " etc " ) ;
2017-07-20 04:00:46 +08:00
}
2021-02-18 00:44:49 +08:00
if ( ProjectSettings : : get_singleton ( ) - > get ( " rendering/textures/vram_compression/import_pvrtc " ) ) {
2020-12-11 06:01:00 +08:00
_save_stex ( image , p_save_path + " .pvrtc.stex " , compress_mode , lossy , Image : : COMPRESS_PVRTC1_4 , mipmaps , stream , detect_3d , detect_roughness , detect_normal , force_normal , srgb_friendly_pack , true , mipmap_limit , normal_image , roughness_channel ) ;
2017-06-17 08:47:28 +08:00
r_platform_variants - > push_back ( " pvrtc " ) ;
2019-02-27 05:43:37 +08:00
formats_imported . push_back ( " pvrtc " ) ;
2017-06-17 08:47:28 +08:00
}
2017-02-01 20:45:45 +08:00
2017-09-06 07:17:26 +08:00
if ( ! ok_on_pc ) {
2018-09-13 09:38:39 +08:00
EditorNode : : add_io_error ( " Warning, no suitable PC VRAM compression enabled in Project Settings. This texture will not display correctly on PC. " ) ;
2017-09-06 07:17:26 +08:00
}
2017-02-01 20:45:45 +08:00
} else {
//import normally
2020-05-01 20:34:23 +08:00
_save_stex ( image , p_save_path + " .stex " , compress_mode , lossy , Image : : COMPRESS_S3TC /*this is ignored */ , mipmaps , stream , detect_3d , detect_roughness , detect_normal , force_normal , srgb_friendly_pack , false , mipmap_limit , normal_image , roughness_channel ) ;
2017-02-01 20:45:45 +08:00
}
2019-02-27 05:43:37 +08:00
if ( r_metadata ) {
Dictionary metadata ;
2019-09-27 10:16:44 +08:00
metadata [ " vram_texture " ] = compress_mode = = COMPRESS_VRAM_COMPRESSED ;
2019-02-27 05:43:37 +08:00
if ( formats_imported . size ( ) ) {
metadata [ " imported_formats " ] = formats_imported ;
}
* r_metadata = metadata ;
}
2017-02-01 20:45:45 +08:00
return OK ;
}
2019-02-27 05:43:37 +08:00
const char * ResourceImporterTexture : : compression_formats [ ] = {
" bptc " ,
" s3tc " ,
" etc " ,
" etc2 " ,
" pvrtc " ,
2020-04-02 07:20:12 +08:00
nullptr
2019-02-27 05:43:37 +08:00
} ;
String ResourceImporterTexture : : get_import_settings_string ( ) const {
String s ;
int index = 0 ;
while ( compression_formats [ index ] ) {
2021-02-18 00:44:49 +08:00
String setting_path = " rendering/textures/vram_compression/import_ " + String ( compression_formats [ index ] ) ;
2019-02-27 05:43:37 +08:00
bool test = ProjectSettings : : get_singleton ( ) - > get ( setting_path ) ;
if ( test ) {
s + = String ( compression_formats [ index ] ) ;
}
index + + ;
}
return s ;
}
bool ResourceImporterTexture : : are_import_settings_valid ( const String & p_path ) const {
//will become invalid if formats are missing to import
Dictionary metadata = ResourceFormatImporter : : get_singleton ( ) - > get_resource_metadata ( p_path ) ;
if ( ! metadata . has ( " vram_texture " ) ) {
return false ;
}
bool vram = metadata [ " vram_texture " ] ;
if ( ! vram ) {
return true ; //do not care about non vram
}
Vector < String > formats_imported ;
if ( metadata . has ( " imported_formats " ) ) {
formats_imported = metadata [ " imported_formats " ] ;
}
int index = 0 ;
bool valid = true ;
while ( compression_formats [ index ] ) {
2021-02-18 00:44:49 +08:00
String setting_path = " rendering/textures/vram_compression/import_ " + String ( compression_formats [ index ] ) ;
2019-02-27 05:43:37 +08:00
bool test = ProjectSettings : : get_singleton ( ) - > get ( setting_path ) ;
if ( test ) {
if ( formats_imported . find ( compression_formats [ index ] ) = = - 1 ) {
valid = false ;
break ;
}
}
index + + ;
}
return valid ;
}
2020-04-02 07:20:12 +08:00
ResourceImporterTexture * ResourceImporterTexture : : singleton = nullptr ;
2017-02-06 11:38:39 +08:00
2017-03-05 23:44:50 +08:00
ResourceImporterTexture : : ResourceImporterTexture ( ) {
singleton = this ;
2020-05-01 20:34:23 +08:00
StreamTexture2D : : request_3d_callback = _texture_reimport_3d ;
StreamTexture2D : : request_roughness_callback = _texture_reimport_roughness ;
StreamTexture2D : : request_normal_callback = _texture_reimport_normal ;
2017-02-01 20:45:45 +08:00
}
2017-02-06 11:38:39 +08:00
2017-03-05 23:44:50 +08:00
ResourceImporterTexture : : ~ ResourceImporterTexture ( ) {
2017-02-06 11:38:39 +08:00
}