initial commit, 4.5 stable

modules/svg/SCsub

@@ -0,0 +1,110 @@
+#!/usr/bin/env python
+from misc.utility.scons_hints import *
+
+Import("env")
+Import("env_modules")
+
+env_svg = env_modules.Clone()
+
+# Thirdparty source files
+
+thirdparty_obj = []
+
+thirdparty_dir = "#thirdparty/thorvg/"
+thirdparty_sources = [
+    # common
+    "src/common/tvgCompressor.cpp",
+    "src/common/tvgMath.cpp",
+    "src/common/tvgStr.cpp",
+    # SVG parser
+    "src/loaders/svg/tvgSvgCssStyle.cpp",
+    "src/loaders/svg/tvgSvgLoader.cpp",
+    "src/loaders/svg/tvgSvgPath.cpp",
+    "src/loaders/svg/tvgSvgSceneBuilder.cpp",
+    "src/loaders/svg/tvgSvgUtil.cpp",
+    "src/loaders/svg/tvgXmlParser.cpp",
+    "src/loaders/raw/tvgRawLoader.cpp",
+    # image loaders
+    "src/loaders/external_png/tvgPngLoader.cpp",
+    # renderer common
+    "src/renderer/tvgAccessor.cpp",
+    # "src/renderer/tvgAnimation.cpp",
+    "src/renderer/tvgCanvas.cpp",
+    "src/renderer/tvgFill.cpp",
+    # "src/renderer/tvgGlCanvas.cpp",
+    "src/renderer/tvgInitializer.cpp",
+    "src/renderer/tvgLoader.cpp",
+    "src/renderer/tvgPaint.cpp",
+    "src/renderer/tvgPicture.cpp",
+    "src/renderer/tvgRender.cpp",
+    # "src/renderer/tvgSaver.cpp",
+    "src/renderer/tvgScene.cpp",
+    "src/renderer/tvgShape.cpp",
+    "src/renderer/tvgSwCanvas.cpp",
+    "src/renderer/tvgTaskScheduler.cpp",
+    "src/renderer/tvgText.cpp",
+    # "src/renderer/tvgWgCanvas.cpp",
+    # renderer sw_engine
+    "src/renderer/sw_engine/tvgSwFill.cpp",
+    "src/renderer/sw_engine/tvgSwImage.cpp",
+    "src/renderer/sw_engine/tvgSwMath.cpp",
+    "src/renderer/sw_engine/tvgSwMemPool.cpp",
+    "src/renderer/sw_engine/tvgSwPostEffect.cpp",
+    "src/renderer/sw_engine/tvgSwRaster.cpp",
+    "src/renderer/sw_engine/tvgSwRenderer.cpp",
+    "src/renderer/sw_engine/tvgSwRle.cpp",
+    "src/renderer/sw_engine/tvgSwShape.cpp",
+    "src/renderer/sw_engine/tvgSwStroke.cpp",
+]
+
+if env["module_webp_enabled"]:
+    thirdparty_sources += ["src/loaders/external_webp/tvgWebpLoader.cpp"]
+    env_svg.Append(CPPDEFINES=["THORVG_WEBP_LOADER_SUPPORT"])
+if env["module_jpg_enabled"]:
+    thirdparty_sources += ["src/loaders/external_jpg/tvgJpgLoader.cpp"]
+    env_svg.Append(CPPDEFINES=["THORVG_JPG_LOADER_SUPPORT"])
+
+thirdparty_sources = [thirdparty_dir + file for file in thirdparty_sources]
+
+env_svg.Prepend(CPPEXTPATH=[thirdparty_dir + "inc"])
+
+# Enable ThorVG static object linking.
+env_svg.Append(CPPDEFINES=["TVG_STATIC"])
+# Explicit support for embedded images in svg.
+env_svg.Append(CPPDEFINES=["THORVG_FILE_IO_SUPPORT"])
+
+env_thirdparty = env_svg.Clone()
+env_thirdparty.disable_warnings()
+env_thirdparty.Prepend(
+    CPPEXTPATH=[
+        thirdparty_dir + "src/common",
+        thirdparty_dir + "src/loaders/svg",
+        thirdparty_dir + "src/renderer",
+        thirdparty_dir + "src/renderer/sw_engine",
+        thirdparty_dir + "src/loaders/raw",
+        thirdparty_dir + "src/loaders/external_png",
+    ]
+)
+if env["builtin_libpng"]:
+    env_thirdparty.Prepend(CPPEXTPATH=["#thirdparty/libpng"])
+if env["module_webp_enabled"]:
+    env_thirdparty.Prepend(CPPEXTPATH=[thirdparty_dir + "src/loaders/external_webp"])
+    if env["builtin_libwebp"]:
+        env_thirdparty.Prepend(CPPEXTPATH=["#thirdparty/libwebp/src"])
+if env["module_jpg_enabled"]:
+    env_thirdparty.Prepend(CPPEXTPATH=[thirdparty_dir + "src/loaders/external_jpg"])
+    if env["builtin_libjpeg_turbo"]:
+        env_thirdparty.Prepend(CPPEXTPATH=["#thirdparty/libjpeg-turbo/src"])
+
+env_thirdparty.add_source_files(thirdparty_obj, thirdparty_sources)
+env.modules_sources += thirdparty_obj
+
+# Godot source files
+
+module_obj = []
+
+env_svg.add_source_files(module_obj, "*.cpp")
+env.modules_sources += module_obj
+
+# Needed to force rebuilding the module files when the thirdparty library is updated.
+env.Depends(module_obj, thirdparty_obj)

modules/svg/config.py

@@ -0,0 +1,7 @@
+def can_build(env, platform):
+    env.module_add_dependencies("svg", ["jpg", "webp"], True)
+    return True
+
+
+def configure(env):
+    pass

modules/svg/image_loader_svg.cpp

@@ -0,0 +1,189 @@
+/**************************************************************************/
+/*  image_loader_svg.cpp                                                  */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* 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_loader_svg.h"
+
+#include "core/os/memory.h"
+#include "core/variant/variant.h"
+
+#include <thorvg.h>
+
+HashMap<Color, Color> ImageLoaderSVG::forced_color_map = HashMap<Color, Color>();
+
+void ImageLoaderSVG::set_forced_color_map(const HashMap<Color, Color> &p_color_map) {
+	forced_color_map = p_color_map;
+}
+
+void ImageLoaderSVG::_replace_color_property(const HashMap<Color, Color> &p_color_map, const String &p_prefix, String &r_string) {
+	// Replace colors in the SVG based on what is passed in `p_color_map`.
+	// Used to change the colors of editor icons based on the used theme.
+	// The strings being replaced are typically of the form:
+	//   fill="#5abbef"
+	// But can also be 3-letter codes, include alpha, be "none" or a named color
+	// string ("blue"). So we convert to Godot Color to compare with `p_color_map`.
+
+	const int prefix_len = p_prefix.length();
+	int pos = r_string.find(p_prefix);
+	while (pos != -1) {
+		pos += prefix_len; // Skip prefix.
+		int end_pos = r_string.find_char('"', pos);
+		ERR_FAIL_COND_MSG(end_pos == -1, vformat("Malformed SVG string after property \"%s\".", p_prefix));
+		const String color_code = r_string.substr(pos, end_pos - pos);
+		if (color_code != "none" && !color_code.begins_with("url(")) {
+			const Color color = Color(color_code); // Handles both HTML codes and named colors.
+			if (p_color_map.has(color)) {
+				r_string = r_string.left(pos) + "#" + p_color_map[color].to_html(false) + r_string.substr(end_pos);
+			}
+		}
+		// Search for other occurrences.
+		pos = r_string.find(p_prefix, pos);
+	}
+}
+
+Ref<Image> ImageLoaderSVG::load_mem_svg(const uint8_t *p_svg, int p_size, float p_scale) {
+	Ref<Image> img;
+	img.instantiate();
+
+	Error err = create_image_from_utf8_buffer(img, p_svg, p_size, p_scale, false);
+	ERR_FAIL_COND_V_MSG(err != OK, Ref<Image>(), vformat("ImageLoaderSVG: Failed to create SVG from buffer, error code %d.", err));
+
+	return img;
+}
+
+Error ImageLoaderSVG::create_image_from_utf8_buffer(Ref<Image> p_image, const uint8_t *p_buffer, int p_buffer_size, float p_scale, bool p_upsample) {
+	ERR_FAIL_COND_V_MSG(Math::is_zero_approx(p_scale), ERR_INVALID_PARAMETER, "ImageLoaderSVG: Can't load SVG with a scale of 0.");
+
+	std::unique_ptr<tvg::Picture> picture = tvg::Picture::gen();
+
+	tvg::Result result = picture->load((const char *)p_buffer, p_buffer_size, "svg", true);
+	if (result != tvg::Result::Success) {
+		return ERR_INVALID_DATA;
+	}
+	float fw, fh;
+	picture->size(&fw, &fh);
+
+	uint32_t width = MAX(1, std::round(fw * p_scale));
+	uint32_t height = MAX(1, std::round(fh * p_scale));
+
+	const uint32_t max_dimension = 16384;
+	if (width > max_dimension || height > max_dimension) {
+		WARN_PRINT(vformat(
+				String::utf8("ImageLoaderSVG: Target canvas dimensions %d×%d (with scale %.2f) exceed the max supported dimensions %d×%d. The target canvas will be scaled down."),
+				width, height, p_scale, max_dimension, max_dimension));
+		width = MIN(width, max_dimension);
+		height = MIN(height, max_dimension);
+	}
+
+	picture->size(width, height);
+
+	std::unique_ptr<tvg::SwCanvas> sw_canvas = tvg::SwCanvas::gen();
+	Vector<uint8_t> buffer;
+	buffer.resize(sizeof(uint32_t) * width * height);
+
+	tvg::Result res = sw_canvas->target((uint32_t *)buffer.ptrw(), width, width, height, tvg::SwCanvas::ABGR8888S);
+	if (res != tvg::Result::Success) {
+		ERR_FAIL_V_MSG(FAILED, "ImageLoaderSVG: Couldn't set target on ThorVG canvas.");
+	}
+
+	res = sw_canvas->push(std::move(picture));
+	if (res != tvg::Result::Success) {
+		ERR_FAIL_V_MSG(FAILED, "ImageLoaderSVG: Couldn't insert ThorVG picture on canvas.");
+	}
+
+	res = sw_canvas->draw();
+	if (res != tvg::Result::Success) {
+		ERR_FAIL_V_MSG(FAILED, "ImageLoaderSVG: Couldn't draw ThorVG pictures on canvas.");
+	}
+
+	res = sw_canvas->sync();
+	if (res != tvg::Result::Success) {
+		ERR_FAIL_V_MSG(FAILED, "ImageLoaderSVG: Couldn't sync ThorVG canvas.");
+	}
+
+	p_image->set_data(width, height, false, Image::FORMAT_RGBA8, buffer);
+
+	res = sw_canvas->clear(true);
+
+	return OK;
+}
+
+Error ImageLoaderSVG::create_image_from_utf8_buffer(Ref<Image> p_image, const PackedByteArray &p_buffer, float p_scale, bool p_upsample) {
+	return create_image_from_utf8_buffer(p_image, p_buffer.ptr(), p_buffer.size(), p_scale, p_upsample);
+}
+
+Error ImageLoaderSVG::create_image_from_string(Ref<Image> p_image, String p_string, float p_scale, bool p_upsample, const HashMap<Color, Color> &p_color_map) {
+	if (p_color_map.size()) {
+		_replace_color_property(p_color_map, "stop-color=\"", p_string);
+		_replace_color_property(p_color_map, "fill=\"", p_string);
+		_replace_color_property(p_color_map, "stroke=\"", p_string);
+	}
+
+	PackedByteArray bytes = p_string.to_utf8_buffer();
+
+	return create_image_from_utf8_buffer(p_image, bytes, p_scale, p_upsample);
+}
+
+void ImageLoaderSVG::get_recognized_extensions(List<String> *p_extensions) const {
+	p_extensions->push_back("svg");
+}
+
+Error ImageLoaderSVG::load_image(Ref<Image> p_image, Ref<FileAccess> p_fileaccess, BitField<ImageFormatLoader::LoaderFlags> p_flags, float p_scale) {
+	const uint64_t len = p_fileaccess->get_length() - p_fileaccess->get_position();
+	Vector<uint8_t> buffer;
+	buffer.resize(len);
+	p_fileaccess->get_buffer(buffer.ptrw(), buffer.size());
+
+	String svg;
+	Error err = svg.append_utf8((const char *)buffer.ptr(), buffer.size());
+	if (err != OK) {
+		return err;
+	}
+
+	if (p_flags & FLAG_CONVERT_COLORS) {
+		err = create_image_from_string(p_image, svg, p_scale, false, forced_color_map);
+	} else {
+		err = create_image_from_string(p_image, svg, p_scale, false, HashMap<Color, Color>());
+	}
+
+	if (err != OK) {
+		return err;
+	} else if (p_image->is_empty()) {
+		return ERR_INVALID_DATA;
+	}
+
+	if (p_flags & FLAG_FORCE_LINEAR) {
+		p_image->srgb_to_linear();
+	}
+	return OK;
+}
+
+ImageLoaderSVG::ImageLoaderSVG() {
+	Image::_svg_scalable_mem_loader_func = load_mem_svg;
+}

modules/svg/image_loader_svg.h

@@ -0,0 +1,54 @@
+/**************************************************************************/
+/*  image_loader_svg.h                                                    */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* 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.                 */
+/**************************************************************************/
+
+#pragma once
+
+#include "core/io/image_loader.h"
+
+class ImageLoaderSVG : public ImageFormatLoader {
+	static HashMap<Color, Color> forced_color_map;
+
+	static void _replace_color_property(const HashMap<Color, Color> &p_color_map, const String &p_prefix, String &r_string);
+
+	static Ref<Image> load_mem_svg(const uint8_t *p_svg, int p_size, float p_scale);
+
+public:
+	static void set_forced_color_map(const HashMap<Color, Color> &p_color_map);
+
+	static Error create_image_from_utf8_buffer(Ref<Image> p_image, const uint8_t *p_buffer, int p_buffer_size, float p_scale, bool p_upsample);
+	static Error create_image_from_utf8_buffer(Ref<Image> p_image, const PackedByteArray &p_buffer, float p_scale, bool p_upsample);
+
+	static Error create_image_from_string(Ref<Image> p_image, String p_string, float p_scale, bool p_upsample, const HashMap<Color, Color> &p_color_map);
+
+	virtual Error load_image(Ref<Image> p_image, Ref<FileAccess> p_fileaccess, BitField<ImageFormatLoader::LoaderFlags> p_flags, float p_scale) override;
+	virtual void get_recognized_extensions(List<String> *p_extensions) const override;
+
+	ImageLoaderSVG();
+};

modules/svg/register_types.cpp

@@ -0,0 +1,73 @@
+/**************************************************************************/
+/*  register_types.cpp                                                    */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* 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 "register_types.h"
+
+#include "image_loader_svg.h"
+
+#include <thorvg.h>
+
+#ifdef THREADS_ENABLED
+#define TVG_THREADS 1
+#else
+#define TVG_THREADS 0
+#endif
+
+static Ref<ImageLoaderSVG> image_loader_svg;
+
+void initialize_svg_module(ModuleInitializationLevel p_level) {
+	if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) {
+		return;
+	}
+
+	tvg::CanvasEngine tvgEngine = tvg::CanvasEngine::Sw;
+
+	if (tvg::Initializer::init(tvgEngine, TVG_THREADS) != tvg::Result::Success) {
+		return;
+	}
+
+	image_loader_svg.instantiate();
+	ImageLoader::add_image_format_loader(image_loader_svg);
+}
+
+void uninitialize_svg_module(ModuleInitializationLevel p_level) {
+	if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) {
+		return;
+	}
+
+	if (image_loader_svg.is_null()) {
+		// It failed to initialize so it was not added.
+		return;
+	}
+
+	ImageLoader::remove_image_format_loader(image_loader_svg);
+	image_loader_svg.unref();
+	tvg::Initializer::term(tvg::CanvasEngine::Sw);
+}

modules/svg/register_types.h

@@ -0,0 +1,36 @@
+/**************************************************************************/
+/*  register_types.h                                                      */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* 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.                 */
+/**************************************************************************/
+
+#pragma once
+
+#include "modules/register_module_types.h"
+
+void initialize_svg_module(ModuleInitializationLevel p_level);
+void uninitialize_svg_module(ModuleInitializationLevel p_level);