PVRTC: Move compress func to `modules/pvr`, drop obsolete PVRTexTool code

The code we had for PVRTexTool doesn't work as it's not compatible with current
PVRTexTool CLI options, and likely hasn't been for years.

Instead, we have our own vendored pvrtccompressor thirdparty library which all
users have thus de-facto been using. This commit moves the compress code to
`modules/pvr` where it belongs.

There's no proper compress function for PVRTC 2-bit format, that's a bug that
will need to be fixed (currently it's compressed as 4-bit format even if you
use Image::FORMAT_PVRTC2).

Fixes #28669.

editor/editor_node.cpp

@@ -58,7 +58,9 @@
 #include "scene/gui/tab_container.h"
 #include "scene/gui/tabs.h"
 #include "scene/gui/texture_progress.h"
+#include "scene/main/window.h"
 #include "scene/resources/packed_scene.h"
+#include "servers/display_server.h"
 #include "servers/navigation_server_2d.h"
 #include "servers/navigation_server_3d.h"
 #include "servers/physics_server_2d.h"
@@ -172,12 +174,10 @@
 #include "editor/progress_dialog.h"
 #include "editor/project_export.h"
 #include "editor/project_settings_editor.h"
-#include "editor/pvrtc_compress.h"
 #include "editor/quick_open.h"
 #include "editor/register_exporters.h"
 #include "editor/settings_config_dialog.h"
-#include "scene/main/window.h"
-#include "servers/display_server.h"
+
 #include <stdio.h>
 #include <stdlib.h>
 
@@ -5726,8 +5726,6 @@ EditorNode::EditorNode() {
 		EditorInspector::add_inspector_plugin(smp);
 	}
 
-	_pvrtc_register_compressors();
-
 	editor_selection = memnew(EditorSelection);
 
 	EditorFileSystem *efs = memnew(EditorFileSystem);

editor/editor_settings.cpp

@@ -407,15 +407,6 @@ void EditorSettings::_load_defaults(Ref<ConfigFile> p_extra_config) {
 	_initial_set("filesystem/file_dialog/thumbnail_size", 64);
 	hints["filesystem/file_dialog/thumbnail_size"] = PropertyInfo(Variant::INT, "filesystem/file_dialog/thumbnail_size", PROPERTY_HINT_RANGE, "32,128,16");
 
-	// Import
-	_initial_set("filesystem/import/pvrtc_texture_tool", "");
-#ifdef WINDOWS_ENABLED
-	hints["filesystem/import/pvrtc_texture_tool"] = PropertyInfo(Variant::STRING, "filesystem/import/pvrtc_texture_tool", PROPERTY_HINT_GLOBAL_FILE, "*.exe");
-#else
-	hints["filesystem/import/pvrtc_texture_tool"] = PropertyInfo(Variant::STRING, "filesystem/import/pvrtc_texture_tool", PROPERTY_HINT_GLOBAL_FILE, "");
-#endif
-	_initial_set("filesystem/import/pvrtc_fast_conversion", false);
-
 	/* Docks */
 
 	// SceneTree

editor/pvrtc_compress.cpp

@@ -1,141 +0,0 @@
-/*************************************************************************/
-/*  pvrtc_compress.cpp                                                   */
-/*************************************************************************/
-/*                       This file is part of:                           */
-/*                           GODOT ENGINE                                */
-/*                      https://godotengine.org                          */
-/*************************************************************************/
-/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur.                 */
-/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md).   */
-/*                                                                       */
-/* 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 "pvrtc_compress.h"
-
-#include "core/io/resource_loader.h"
-#include "core/io/resource_saver.h"
-#include "core/os/dir_access.h"
-#include "core/os/file_access.h"
-#include "core/os/os.h"
-#include "editor_settings.h"
-#include "scene/resources/texture.h"
-
-static void (*_base_image_compress_pvrtc2_func)(Image *) = nullptr;
-static void (*_base_image_compress_pvrtc4_func)(Image *) = nullptr;
-
-static void _compress_image(Image::CompressMode p_mode, Image *p_image) {
-	String ttpath = EditorSettings::get_singleton()->get("filesystem/import/pvrtc_texture_tool");
-
-	if (ttpath.strip_edges() == "" || !FileAccess::exists(ttpath)) {
-		switch (p_mode) {
-			case Image::COMPRESS_PVRTC2:
-				if (_base_image_compress_pvrtc2_func) {
-					_base_image_compress_pvrtc2_func(p_image);
-				} else if (_base_image_compress_pvrtc4_func) {
-					_base_image_compress_pvrtc4_func(p_image);
-				}
-				break;
-			case Image::COMPRESS_PVRTC4:
-				if (_base_image_compress_pvrtc4_func) {
-					_base_image_compress_pvrtc4_func(p_image);
-				}
-				break;
-			default:
-				ERR_FAIL_MSG("Unsupported Image compress mode used in PVRTC module.");
-		}
-		return;
-	}
-
-	String tmppath = EditorSettings::get_singleton()->get_cache_dir();
-	String src_img = tmppath.plus_file("_tmp_src_img.png");
-	String dst_img = tmppath.plus_file("_tmp_dst_img.pvr");
-
-	List<String> args;
-	args.push_back("-i");
-	args.push_back(src_img);
-	args.push_back("-o");
-	args.push_back(dst_img);
-	args.push_back("-f");
-
-	switch (p_mode) {
-		case Image::COMPRESS_PVRTC2:
-			args.push_back("PVRTC2");
-			break;
-		case Image::COMPRESS_PVRTC4:
-			args.push_back("PVRTC4");
-			break;
-		case Image::COMPRESS_ETC:
-			args.push_back("ETC");
-			break;
-		default:
-			ERR_FAIL_MSG("Unsupported Image compress mode used in PVRTC module.");
-	}
-
-	if (EditorSettings::get_singleton()->get("filesystem/import/pvrtc_fast_conversion").operator bool()) {
-		args.push_back("-pvrtcfast");
-	}
-	if (p_image->has_mipmaps()) {
-		args.push_back("-m");
-	}
-
-	// Save source PNG.
-	Ref<ImageTexture> t = memnew(ImageTexture);
-	t->create_from_image(Ref<Image>(p_image));
-	ResourceSaver::save(src_img, t);
-
-	Error err = OS::get_singleton()->execute(ttpath, args, true);
-	if (err != OK) {
-		// Clean up generated files.
-		DirAccess::remove_file_or_error(src_img);
-		DirAccess::remove_file_or_error(dst_img);
-		ERR_FAIL_MSG("Could not execute PVRTC tool: " + ttpath);
-	}
-
-	t = ResourceLoader::load(dst_img, "Texture2D");
-	if (t.is_null()) {
-		// Clean up generated files.
-		DirAccess::remove_file_or_error(src_img);
-		DirAccess::remove_file_or_error(dst_img);
-		ERR_FAIL_MSG("Can't load back converted image using PVRTC tool.");
-	}
-
-	p_image->copy_internals_from(t->get_data());
-
-	// Clean up generated files.
-	DirAccess::remove_file_or_error(src_img);
-	DirAccess::remove_file_or_error(dst_img);
-}
-
-static void _compress_pvrtc2(Image *p_image) {
-	_compress_image(Image::COMPRESS_PVRTC2, p_image);
-}
-
-static void _compress_pvrtc4(Image *p_image) {
-	_compress_image(Image::COMPRESS_PVRTC4, p_image);
-}
-
-void _pvrtc_register_compressors() {
-	_base_image_compress_pvrtc2_func = Image::_image_compress_pvrtc2_func;
-	_base_image_compress_pvrtc4_func = Image::_image_compress_pvrtc4_func;
-
-	Image::_image_compress_pvrtc2_func = _compress_pvrtc2;
-	Image::_image_compress_pvrtc4_func = _compress_pvrtc4;
-}

modules/etc/image_etc.cpp → modules/etc/image_compress_etc.cpp

@@ -1,5 +1,5 @@
 /*************************************************************************/
-/*  image_etc.cpp                                                        */
+/*  image_compress_etc.cpp                                               */
 /*************************************************************************/
 /*                       This file is part of:                           */
 /*                           GODOT ENGINE                                */
@@ -28,14 +28,16 @@
 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
 /*************************************************************************/
 
-#include "image_etc.h"
-#include "Etc.h"
-#include "EtcFilter.h"
+#include "image_compress_etc.h"
+
 #include "core/io/image.h"
 #include "core/os/copymem.h"
 #include "core/os/os.h"
 #include "core/string/print_string.h"
 
+#include <Etc.h>
+#include <EtcFilter.h>
+
 static Image::Format _get_etc2_mode(Image::UsedChannels format) {
 	switch (format) {
 		case Image::USED_CHANNELS_R:

modules/etc/image_etc.h → modules/etc/image_compress_etc.h

@@ -1,5 +1,5 @@
 /*************************************************************************/
-/*  image_etc.h                                                          */
+/*  image_compress_etc.h                                                 */
 /*************************************************************************/
 /*                       This file is part of:                           */
 /*                           GODOT ENGINE                                */
@@ -28,9 +28,9 @@
 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
 /*************************************************************************/
 
-#ifndef IMAGE_ETC1_H
-#define IMAGE_ETC1_H
+#ifndef IMAGE_COMPRESS_ETC_H
+#define IMAGE_COMPRESS_ETC_H
 
 void _register_etc_compress_func();
 
-#endif // IMAGE_ETC_H
+#endif // IMAGE_COMPRESS_ETC_H

modules/etc/register_types.cpp

@@ -30,7 +30,7 @@
 
 #include "register_types.h"
 
-#include "image_etc.h"
+#include "image_compress_etc.h"
 #include "texture_loader_pkm.h"
 
 static Ref<ResourceFormatPKM> resource_loader_pkm;

modules/pvr/image_compress_pvrtc.cpp

@@ -0,0 +1,86 @@
+/*************************************************************************/
+/*  image_compress_pvrtc.cpp                                             */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md).   */
+/*                                                                       */
+/* 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_pvrtc.h"
+
+#include "core/io/image.h"
+#include "core/object/reference.h"
+
+#include <PvrTcEncoder.h>
+#include <RgbaBitmap.h>
+
+static void _compress_pvrtc4(Image *p_img) {
+	Ref<Image> img = p_img->duplicate();
+
+	bool make_mipmaps = false;
+	if (!img->is_size_po2() || img->get_width() != img->get_height()) {
+		make_mipmaps = img->has_mipmaps();
+		img->resize_to_po2(true);
+	}
+	img->convert(Image::FORMAT_RGBA8);
+	if (!img->has_mipmaps() && make_mipmaps) {
+		img->generate_mipmaps();
+	}
+
+	bool use_alpha = img->detect_alpha();
+
+	Ref<Image> new_img;
+	new_img.instance();
+	new_img->create(img->get_width(), img->get_height(), img->has_mipmaps(), use_alpha ? Image::FORMAT_PVRTC4A : Image::FORMAT_PVRTC4);
+
+	Vector<uint8_t> data = new_img->get_data();
+	{
+		uint8_t *wr = data.ptrw();
+		const uint8_t *r = img->get_data().ptr();
+
+		for (int i = 0; i <= new_img->get_mipmap_count(); i++) {
+			int ofs, size, w, h;
+			img->get_mipmap_offset_size_and_dimensions(i, ofs, size, w, h);
+			Javelin::RgbaBitmap bm(w, h);
+			void *dst = (void *)bm.GetData();
+			copymem(dst, &r[ofs], size);
+			Javelin::ColorRgba<unsigned char> *dp = bm.GetData();
+			for (int j = 0; j < size / 4; j++) {
+				// Red and blue colors are swapped.
+				SWAP(dp[j].r, dp[j].b);
+			}
+			new_img->get_mipmap_offset_size_and_dimensions(i, ofs, size, w, h);
+			Javelin::PvrTcEncoder::EncodeRgba4Bpp(&wr[ofs], bm);
+		}
+	}
+
+	p_img->create(new_img->get_width(), new_img->get_height(), new_img->has_mipmaps(), new_img->get_format(), data);
+}
+
+void _register_pvrtc_compress_func() {
+	// FIXME: We claim to support PVRTC2 but use the same method as for PVRTC4.
+	Image::_image_compress_pvrtc2_func = _compress_pvrtc4;
+	Image::_image_compress_pvrtc4_func = _compress_pvrtc4;
+}

editor/pvrtc_compress.h → modules/pvr/image_compress_pvrtc.h

@@ -1,5 +1,5 @@
 /*************************************************************************/
-/*  pvrtc_compress.h                                                     */
+/*  image_compress_pvrtc.h                                               */
 /*************************************************************************/
 /*                       This file is part of:                           */
 /*                           GODOT ENGINE                                */
@@ -28,11 +28,9 @@
 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
 /*************************************************************************/
 
-#ifndef PVRTC_COMPRESS_H
-#define PVRTC_COMPRESS_H
+#ifndef IMAGE_COMPRESS_PVRTC_H
+#define IMAGE_COMPRESS_PVRTC_H
 
-#include "core/io/image.h"
+void _register_pvrtc_compress_func();
 
-void _pvrtc_register_compressors();
-
-#endif // PVRTC_COMPRESS_H
+#endif // IMAGE_COMPRESS_PVRTC_H

modules/pvr/register_types.cpp

@@ -30,6 +30,7 @@
 
 #include "register_types.h"
 
+#include "image_compress_pvrtc.h"
 #include "texture_loader_pvr.h"
 
 static Ref<ResourceFormatPVR> resource_loader_pvr;
@@ -37,6 +38,8 @@ static Ref<ResourceFormatPVR> resource_loader_pvr;
 void register_pvr_types() {
 	resource_loader_pvr.instance();
 	ResourceLoader::add_resource_format_loader(resource_loader_pvr);
+
+	_register_pvrtc_compress_func();
 }
 
 void unregister_pvr_types() {

modules/pvr/texture_loader_pvr.cpp

@@ -29,11 +29,8 @@
 /*************************************************************************/
 
 #include "texture_loader_pvr.h"
-#include "PvrTcEncoder.h"
-#include "RgbaBitmap.h"
+
 #include "core/os/file_access.h"
-#include <string.h>
-#include <new>
 
 static void _pvrtc_decompress(Image *p_img);
 
@@ -183,53 +180,8 @@ String ResourceFormatPVR::get_resource_type(const String &p_path) const {
 	return "";
 }
 
-static void _compress_pvrtc4(Image *p_img) {
-	Ref<Image> img = p_img->duplicate();
-
-	bool make_mipmaps = false;
-	if (!img->is_size_po2() || img->get_width() != img->get_height()) {
-		make_mipmaps = img->has_mipmaps();
-		img->resize_to_po2(true);
-	}
-	img->convert(Image::FORMAT_RGBA8);
-	if (!img->has_mipmaps() && make_mipmaps) {
-		img->generate_mipmaps();
-	}
-
-	bool use_alpha = img->detect_alpha();
-
-	Ref<Image> new_img;
-	new_img.instance();
-	new_img->create(img->get_width(), img->get_height(), img->has_mipmaps(), use_alpha ? Image::FORMAT_PVRTC4A : Image::FORMAT_PVRTC4);
-
-	Vector<uint8_t> data = new_img->get_data();
-	{
-		uint8_t *wr = data.ptrw();
-		const uint8_t *r = img->get_data().ptr();
-
-		for (int i = 0; i <= new_img->get_mipmap_count(); i++) {
-			int ofs, size, w, h;
-			img->get_mipmap_offset_size_and_dimensions(i, ofs, size, w, h);
-			Javelin::RgbaBitmap bm(w, h);
-			void *dst = (void *)bm.GetData();
-			copymem(dst, &r[ofs], size);
-			Javelin::ColorRgba<unsigned char> *dp = bm.GetData();
-			for (int j = 0; j < size / 4; j++) {
-				/* red and blue colors are swapped.  */
-				SWAP(dp[j].r, dp[j].b);
-			}
-			new_img->get_mipmap_offset_size_and_dimensions(i, ofs, size, w, h);
-			Javelin::PvrTcEncoder::EncodeRgba4Bpp(&wr[ofs], bm);
-		}
-	}
-
-	p_img->create(new_img->get_width(), new_img->get_height(), new_img->has_mipmaps(), new_img->get_format(), data);
-}
-
 ResourceFormatPVR::ResourceFormatPVR() {
 	Image::_image_decompress_pvrtc = _pvrtc_decompress;
-	Image::_image_compress_pvrtc4_func = _compress_pvrtc4;
-	Image::_image_compress_pvrtc2_func = _compress_pvrtc4;
 }
 
 /////////////////////////////////////////////////////////