815038962f
This also makes errors related to asset image loading verbose-only, because, frankly, users can't do much about those errors. Spamming them with error messages about some assets on the frontend being broken is pointless.
200 lines
8.2 KiB
C++
200 lines
8.2 KiB
C++
/**************************************************************************/
|
||
/* 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("\"", 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, 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);
|
||
}
|
||
|
||
picture->size(width, 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);
|
||
|
||
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.");
|
||
}
|
||
|
||
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> image;
|
||
image.resize(width * height * sizeof(uint32_t));
|
||
|
||
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;
|
||
}
|
||
}
|
||
|
||
res = sw_canvas->clear(true);
|
||
memfree(buffer);
|
||
|
||
p_image->set_data(width, height, false, Image::FORMAT_RGBA8, image);
|
||
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) {
|
||
String svg = p_fileaccess->get_as_utf8_string();
|
||
|
||
Error 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;
|
||
}
|