lunasvg pr

Author: hai.lin

doc/develop/svg.md

@@ -0,0 +1,54 @@
+# SVG Optimization
+
+Solve Godot built-in SVG parsing problem, some complex SVG files can not be displayed.
+
+## Solution ideas
+
+Use https://github.com/thorvg/thorvg libraries parse, Godot itself on the limited support SVG Tiny specification, won't cause complex SVG parsing.
+Use https://github.com/sammycage/lunasvg parsing library instead.
+
+
+### Modify the record
+
+Replace the parsing file in the godot\modules\svg folder and import the lunasvg parsing library.
+Core code modification:
+
+~~~
+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.");
+
+	auto document = lunasvg::Document::loadFromData((const char *)p_buffer, p_buffer_size);
+
+	uint32_t width = document->width(), height = document->height();
+
+	width *= p_scale;
+	height *= p_scale;
+
+	auto bitmap = document->renderToBitmap(width, height, 0x00000000);
+
+	Vector<uint8_t> result;
+	result.resize(width * height * 4);
+
+	uint32_t *buffer = (uint32_t *)bitmap.data();
+
+	for (uint32_t y = 0; y < height; y++) {
+		for (uint32_t x = 0; x < width; x++) {
+			uint32_t n = buffer[y * width + x];
+			const size_t offset = sizeof(uint32_t) * width * y + sizeof(uint32_t) * x;
+			result.write[offset + 0] = (n >> 16) & 0xff;
+			result.write[offset + 1] = (n >> 8) & 0xff;
+			result.write[offset + 2] = n & 0xff;
+			result.write[offset + 3] = (n >> 24) & 0xff;
+		}
+	}
+
+	p_image->set_data(width, height, false, Image::FORMAT_RGBA8, result);
+
+	return OK;
+}
+~~~
+
+
+TODO
+
+Add large resolution svg cache

doc/develop/svg.zh.md

@@ -0,0 +1,54 @@
+# SVG优化
+
+解决Godot自带SVG解析问题，部分复杂SVG文件无法显示。
+
+## 解决思路
+
+Godot自身使用 https://github.com/thorvg/thorvg 解析库解析，其支持SVG Tiny规范有限制，导致部分复杂SVG解析不了。
+使用https://github.com/sammycage/lunasvg解析库代替。
+
+
+### 修改记录
+
+替换godot\modules\svg文件夹下解析文件，导入lunasvg解析库。
+核心代码修改:
+
+~~~
+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.");
+
+	auto document = lunasvg::Document::loadFromData((const char *)p_buffer, p_buffer_size);
+
+	uint32_t width = document->width(), height = document->height();
+
+	width *= p_scale;
+	height *= p_scale;
+
+	auto bitmap = document->renderToBitmap(width, height, 0x00000000);
+
+	Vector<uint8_t> result;
+	result.resize(width * height * 4);
+
+	uint32_t *buffer = (uint32_t *)bitmap.data();
+
+	for (uint32_t y = 0; y < height; y++) {
+		for (uint32_t x = 0; x < width; x++) {
+			uint32_t n = buffer[y * width + x];
+			const size_t offset = sizeof(uint32_t) * width * y + sizeof(uint32_t) * x;
+			result.write[offset + 0] = (n >> 16) & 0xff;
+			result.write[offset + 1] = (n >> 8) & 0xff;
+			result.write[offset + 2] = n & 0xff;
+			result.write[offset + 3] = (n >> 24) & 0xff;
+		}
+	}
+
+	p_image->set_data(width, height, false, Image::FORMAT_RGBA8, result);
+
+	return OK;
+}
+~~~
+
+
+TODO
+
+增加大分辨率图片cache

modules/svg/SCsub

@@ -64,6 +64,44 @@ env_svg.Prepend(CPPPATH=[thirdparty_dir + "inc"])
 # Enable ThorVG static object linking.
 env_svg.Append(CPPDEFINES=["TVG_STATIC"])
 
+
+
+# ----------- Luna ----------------
+thirdparty_dir2 = "#thirdparty/lunasvg/"
+thirdparty_obj2 = []
+thirdparty_sources2 = [
+    "source/graphics.cpp",
+    "source/lunasvg.cpp",
+    "source/plutovg-blend.c",
+    "source/plutovg-canvas.c",
+    "source/plutovg-font.c",
+    "source/plutovg-ft-math.c",
+    "source/plutovg-ft-raster.c",
+    "source/plutovg-ft-stroker.c",
+    "source/plutovg-matrix.c",
+    "source/plutovg-paint.c",
+    "source/plutovg-path.c",
+    "source/plutovg-rasterize.c",
+    "source/plutovg-surface.c",
+    "source/svgelement.cpp",
+    "source/svggeometryelement.cpp",
+    "source/svglayoutstate.cpp",
+    "source/svgpaintelement.cpp",
+    "source/svgparser.cpp",
+    "source/svgproperty.cpp",
+    "source/svgrenderstate.cpp",
+    "source/svgtextelement.cpp",
+]
+thirdparty_sources2 = [thirdparty_dir2 + file for file in thirdparty_sources2]
+
+env_svg.Prepend(CPPPATH=[thirdparty_dir2 + "include"])
+
+# Enable lunasvg static object linking.
+env_svg.Append(CPPDEFINES=["PLUTOVG_BUILD", "PLUTOVG_BUILD_STATIC", "LUNASVG_BUILD", "LUNASVG_BUILD_STATIC"])
+
+
+#-------------------------------
+
 env_thirdparty = env_svg.Clone()
 env_thirdparty.disable_warnings()
 env_thirdparty.Prepend(
@@ -81,6 +119,9 @@ env_thirdparty.Prepend(
 env_thirdparty.add_source_files(thirdparty_obj, thirdparty_sources)
 env.modules_sources += thirdparty_obj
 
+env_thirdparty.add_source_files(thirdparty_obj2, thirdparty_sources2)
+env.modules_sources += thirdparty_obj2
+
 # Godot source files
 
 module_obj = []
@@ -90,3 +131,4 @@ env.modules_sources += module_obj
 
 # Needed to force rebuilding the module files when the thirdparty library is updated.
 env.Depends(module_obj, thirdparty_obj)
+env.Depends(module_obj, thirdparty_obj2)

modules/svg/image_loader_svg.cpp

@@ -33,7 +33,9 @@
 #include "core/os/memory.h"
 #include "core/variant/variant.h"
 
-#include <thorvg.h>
+#include <lunasvg.h>
+
+#include <iostream>
 
 HashMap<Color, Color> ImageLoaderSVG::forced_color_map = HashMap<Color, Color>();
 
@@ -80,75 +82,33 @@ Ref<Image> ImageLoaderSVG::load_mem_svg(const uint8_t *p_svg, int p_size, float
 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, round(fw * p_scale));
-	uint32_t height = MAX(1, 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);
-	}
+	auto document = lunasvg::Document::loadFromData((const char *)p_buffer, p_buffer_size);
 
-	picture->size(width, height);
+	uint32_t width = document->width(), height = document->height();
 
-	std::unique_ptr<tvg::SwCanvas> sw_canvas = tvg::SwCanvas::gen();
-	// Note: memalloc here, be sure to memfree before any return.
-	uint32_t *buffer = (uint32_t *)memalloc(sizeof(uint32_t) * width * height);
+	width *= p_scale;
+	height *= p_scale;
 
-	tvg::Result res = sw_canvas->target(buffer, width, width, height, tvg::SwCanvas::ARGB8888S);
-	if (res != tvg::Result::Success) {
-		memfree(buffer);
-		ERR_FAIL_V_MSG(FAILED, "ImageLoaderSVG: Couldn't set target on ThorVG canvas.");
-	}
+	auto bitmap = document->renderToBitmap(width, height, 0x00000000);
 
-	res = sw_canvas->push(std::move(picture));
-	if (res != tvg::Result::Success) {
-		memfree(buffer);
-		ERR_FAIL_V_MSG(FAILED, "ImageLoaderSVG: Couldn't insert ThorVG picture on canvas.");
-	}
-
-	res = sw_canvas->draw();
-	if (res != tvg::Result::Success) {
-		memfree(buffer);
-		ERR_FAIL_V_MSG(FAILED, "ImageLoaderSVG: Couldn't draw ThorVG pictures on canvas.");
-	}
-
-	res = sw_canvas->sync();
-	if (res != tvg::Result::Success) {
-		memfree(buffer);
-		ERR_FAIL_V_MSG(FAILED, "ImageLoaderSVG: Couldn't sync ThorVG canvas.");
-	}
+	Vector<uint8_t> result;
+	result.resize(width * height * 4);
 
-	Vector<uint8_t> image;
-	image.resize(width * height * sizeof(uint32_t));
+	uint32_t *buffer = (uint32_t *)bitmap.data();
 
 	for (uint32_t y = 0; y < height; y++) {
 		for (uint32_t x = 0; x < width; x++) {
 			uint32_t n = buffer[y * width + x];
 			const size_t offset = sizeof(uint32_t) * width * y + sizeof(uint32_t) * x;
-			image.write[offset + 0] = (n >> 16) & 0xff;
-			image.write[offset + 1] = (n >> 8) & 0xff;
-			image.write[offset + 2] = n & 0xff;
-			image.write[offset + 3] = (n >> 24) & 0xff;
+			result.write[offset + 0] = (n >> 16) & 0xff;
+			result.write[offset + 1] = (n >> 8) & 0xff;
+			result.write[offset + 2] = n & 0xff;
+			result.write[offset + 3] = (n >> 24) & 0xff;
 		}
 	}
 
-	res = sw_canvas->clear(true);
-	memfree(buffer);
+	p_image->set_data(width, height, false, Image::FORMAT_RGBA8, result);
 
-	p_image->set_data(width, height, false, Image::FORMAT_RGBA8, image);
 	return OK;
 }
 

modules/svg/register_types.cpp

@@ -32,20 +32,13 @@
 
 #include "image_loader_svg.h"
 
-#include <thorvg.h>
-
 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, 1) != tvg::Result::Success) {
-		return;
-	}
-
 	image_loader_svg.instantiate();
 	ImageLoader::add_image_format_loader(image_loader_svg);
 }
@@ -62,5 +55,4 @@ void uninitialize_svg_module(ModuleInitializationLevel p_level) {
 
 	ImageLoader::remove_image_format_loader(image_loader_svg);
 	image_loader_svg.unref();
-	tvg::Initializer::term(tvg::CanvasEngine::Sw);
 }