Merge pull request #8548 from tagcup/etc2comp

Add ETC1/ETC2 compression support though etc2comp.

1 files changed, 181 insertions, 0 deletions

diff --git a/modules/etc/image_etc.cpp b/modules/etc/image_etc.cpp
new file mode 100644
index 0000000000..4ccd5c8d89
--- /dev/null
+++ b/modules/etc/image_etc.cpp
@@ -0,0 +1,181 @@
+/*************************************************************************/
+/*  image_etc.cpp                                                        */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                    http://www.godotengine.org                         */
+/*************************************************************************/
+/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2017 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_etc.h"
+#include "Etc.h"
+#include "EtcFilter.h"
+#include "image.h"
+#include "os/copymem.h"
+#include "os/os.h"
+#include "print_string.h"
+
+static Image::Format _get_etc2_mode(Image::DetectChannels format) {
+	switch (format) {
+		case Image::DETECTED_L:
+		case Image::DETECTED_R:
+			return Image::FORMAT_ETC2_R11;
+
+		case Image::DETECTED_RG:
+			return Image::FORMAT_ETC2_RG11;
+
+		case Image::DETECTED_RGB:
+			return Image::FORMAT_ETC2_RGB8;
+
+		case Image::DETECTED_RGBA:
+			return Image::FORMAT_ETC2_RGBA8;
+
+			// TODO: would be nice if we could use FORMAT_ETC2_RGB8A1 for FORMAT_RGBA5551
+	}
+
+	ERR_FAIL_COND_V(true, Image::FORMAT_MAX);
+}
+
+static Etc::Image::Format _image_format_to_etc2comp_format(Image::Format format) {
+	switch (format) {
+		case Image::FORMAT_ETC:
+			return Etc::Image::Format::ETC1;
+
+		case Image::FORMAT_ETC2_R11:
+			return Etc::Image::Format::R11;
+
+		case Image::FORMAT_ETC2_R11S:
+			return Etc::Image::Format::SIGNED_R11;
+
+		case Image::FORMAT_ETC2_RG11:
+			return Etc::Image::Format::RG11;
+
+		case Image::FORMAT_ETC2_RG11S:
+			return Etc::Image::Format::SIGNED_RG11;
+
+		case Image::FORMAT_ETC2_RGB8:
+			return Etc::Image::Format::RGB8;
+
+		case Image::FORMAT_ETC2_RGBA8:
+			return Etc::Image::Format::RGBA8;
+
+		case Image::FORMAT_ETC2_RGB8A1:
+			return Etc::Image::Format::RGB8A1;
+	}
+
+	ERR_FAIL_COND_V(true, Etc::Image::Format::UNKNOWN);
+}
+
+static void _decompress_etc1(Image *p_img) {
+	// not implemented, to be removed
+}
+
+static void _decompress_etc2(Image *p_img) {
+	// not implemented, to be removed
+}
+
+static void _compress_etc(Image *p_img, float p_lossy_quality, bool force_etc1_format) {
+	Image::Format img_format = p_img->get_format();
+	Image::DetectChannels detected_channels = p_img->get_detected_channels();
+
+	if (img_format >= Image::FORMAT_DXT1) {
+		return; //do not compress, already compressed
+	}
+
+	if (img_format > Image::FORMAT_RGBA8) {
+		// TODO: we should be able to handle FORMAT_RGBA4444 and FORMAT_RGBA5551 eventually
+		return;
+	}
+
+	int imgw = p_img->get_width(), imgh = p_img->get_height();
+	ERR_FAIL_COND(nearest_power_of_2(imgw) != imgw || nearest_power_of_2(imgh) != imgh);
+
+	Image::Format etc_format = force_etc1_format ? Image::FORMAT_ETC : _get_etc2_mode(detected_channels);
+
+	Ref<Image> img = p_img->duplicate();
+
+	if (img->get_format() != Image::FORMAT_RGBA8)
+		img->convert(Image::FORMAT_RGBA8); //still uses RGBA to convert
+
+	PoolVector<uint8_t>::Read r = img->get_data().read();
+
+	int target_size = Image::get_image_data_size(imgw, imgh, etc_format, p_img->has_mipmaps() ? -1 : 0);
+	int mmc = p_img->has_mipmaps() ? Image::get_image_required_mipmaps(imgw, imgh, etc_format) : 0;
+
+	PoolVector<uint8_t> dst_data;
+	dst_data.resize(target_size);
+
+	PoolVector<uint8_t>::Write w = dst_data.write();
+
+	// prepare parameters to be passed to etc2comp
+	int num_cpus = OS::get_singleton()->get_processor_count();
+	int encoding_time = 0;
+	float effort = CLAMP(p_lossy_quality * 100, 0, 100);
+	Etc::ErrorMetric error_metric = Etc::ErrorMetric::BT709; // NOTE: we can experiment with other error metrics
+	Etc::Image::Format etc2comp_etc_format = _image_format_to_etc2comp_format(etc_format);
+
+	int wofs = 0;
+	for (int i = 0; i < mmc + 1; i++) {
+		// convert source image to internal etc2comp format (which is equivalent to Image::FORMAT_RGBAF)
+		// NOTE: We can alternatively add a case to Image::convert to handle Image::FORMAT_RGBAF conversion.
+		int mipmap_ofs = 0, mipmap_size = 0, mipmap_w = 0, mipmap_h = 0;
+		img->get_mipmap_offset_size_and_dimensions(i, mipmap_ofs, mipmap_size, mipmap_w, mipmap_h);
+		const uint8_t *src = &r[mipmap_ofs];
+
+		Etc::ColorFloatRGBA *src_rgba_f = new Etc::ColorFloatRGBA[mipmap_w * mipmap_h];
+		for (int i = 0; i < mipmap_w * mipmap_h; i++) {
+			int si = i * 4; // RGBA8
+			src_rgba_f[i] = Etc::ColorFloatRGBA::ConvertFromRGBA8(src[si], src[si + 1], src[si + 2], src[si + 3]);
+		}
+
+		unsigned char *etc_data = NULL;
+		unsigned int etc_data_len = 0;
+		unsigned int extended_width = 0, extended_height = 0;
+		Etc::Encode((float *)src_rgba_f, mipmap_w, mipmap_h, etc2comp_etc_format, error_metric, effort, num_cpus, num_cpus, &etc_data, &etc_data_len, &extended_width, &extended_height, &encoding_time);
+
+		memcpy(&w[wofs], etc_data, etc_data_len);
+		wofs += etc_data_len;
+
+		delete[] etc_data;
+		delete[] src_rgba_f;
+	}
+
+	p_img->create(imgw, imgh, mmc > 1 ? true : false, etc_format, dst_data);
+}
+
+static void _compress_etc1(Image *p_img, float p_lossy_quality) {
+	_compress_etc(p_img, p_lossy_quality, true);
+}
+
+static void _compress_etc2(Image *p_img, float p_lossy_quality) {
+	_compress_etc(p_img, p_lossy_quality, false);
+}
+
+void _register_etc_compress_func() {
+
+	Image::_image_compress_etc1_func = _compress_etc1;
+	//Image::_image_decompress_etc1 = _decompress_etc1;
+
+	Image::_image_compress_etc2_func = _compress_etc2;
+	//Image::_image_decompress_etc2 = _decompress_etc2;
+}