Skip to content

Implement an importer to support Lottie animation #91580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
beicause wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Implement an importer to support Lottie animation #91580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions modules/svg/SCsub
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,21 @@ thirdparty_sources = [
"src/renderer/sw_engine/tvgSwStroke.cpp",
]

if env.editor_build:
thirdparty_sources += [
"src/renderer/tvgAnimation.cpp",
# Lottie loader
"src/loaders/lottie/tvgLottieAnimation.cpp",
"src/loaders/lottie/tvgLottieBuilder.cpp",
# "src/loaders/lottie/tvgLottieExpressions.cpp",
"src/loaders/lottie/tvgLottieInterpolator.cpp",
"src/loaders/lottie/tvgLottieLoader.cpp",
"src/loaders/lottie/tvgLottieModel.cpp",
"src/loaders/lottie/tvgLottieModifier.cpp",
"src/loaders/lottie/tvgLottieParser.cpp",
"src/loaders/lottie/tvgLottieParserHandler.cpp",
]

if env["module_webp_enabled"]:
thirdparty_sources += ["src/loaders/external_webp/tvgWebpLoader.cpp"]
env_svg.Append(CPPDEFINES=["THORVG_WEBP_LOADER_SUPPORT"])
Expand All @@ -73,6 +88,9 @@ env_svg.Append(CPPDEFINES=["TVG_STATIC"])
# Explicit support for embedded images in svg.
env_svg.Append(CPPDEFINES=["THORVG_FILE_IO_SUPPORT"])

if env.editor_build:
env_svg.Append(CPPDEFINES=["THORVG_LOTTIE_LOADER_SUPPORT", "LOTTIE_ENABLED"])

env_thirdparty = env_svg.Clone()
env_thirdparty.disable_warnings()
env_thirdparty.Prepend(
Expand All @@ -85,6 +103,9 @@ env_thirdparty.Prepend(
thirdparty_dir + "src/loaders/external_png",
]
)

if env.editor_build:
env_thirdparty.Prepend(CPPEXTPATH=[thirdparty_dir + "src/loaders/lottie"])
if env["builtin_libpng"]:
env_thirdparty.Prepend(CPPEXTPATH=["#thirdparty/libpng"])
if env["module_webp_enabled"]:
Expand All @@ -104,6 +125,9 @@ env.modules_sources += thirdparty_obj
module_obj = []

env_svg.add_source_files(module_obj, "*.cpp")
if env.editor_build:
env_svg.add_source_files(module_obj, "editor/*.cpp")

env.modules_sources += module_obj

# Needed to force rebuilding the module files when the thirdparty library is updated.
Expand Down
10 changes: 10 additions & 0 deletions modules/svg/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,13 @@ def can_build(env, platform):

def configure(env):
pass


def get_doc_classes():
return [
"ResourceImporterLottie",
]


def get_doc_path():
return "doc_classes"
37 changes: 37 additions & 0 deletions modules/svg/doc_classes/ResourceImporterLottie.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceImporterLottie" inherits="ResourceImporter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Import a Lottie animation as a SpriteFrames.
</brief_description>
<description>
This imports a Lottie animation to a [SpriteFrames], supports Lottie JSON format.
[b]Note:[/b] This importer only recognizes files with [code].lot[/code] extension. You have to rename Lottie JSON files extension to [code].lot[/code] to import them.
</description>
<tutorials>
</tutorials>
<members>
<member name="lottie/columns" type="int" setter="" getter="" default="0">
The number of columns of the sprite sheet. If it is [code]0[/code], the number of columns will be automatically calculated to be close to the number of rows.
</member>
<member name="lottie/frame_begin" type="float" setter="" getter="" default="0">
The start of the Lottie animation in the range [code]0.0[/code] to [code]1.0[/code].
</member>
<member name="lottie/frame_end" type="float" setter="" getter="" default="1">
The end of the Lottie animation in the range [code]0.0[/code] to [code]1.0[/code]. This value will be clamped to be at least [member lottie/frame_begin].
</member>
<member name="lottie/frame_rate" type="float" setter="" getter="" default="30">
The frame rate Lottie animation should be rendered at. Higher values result in more sprites in the sprite sheet.
</member>
<member name="lottie/image_handling" type="int" setter="" getter="" default="0">
- Embed as Lossless: keeps the textures embedded in the imported scene with Lossless compression.
- Embed as Basis Universal: keeps the textures embedded in the imported scene with Basis Universal compression.
- Extract: extracts the texture to external images, resulting in smaller file sizes and more control over import options.
</member>
<member name="lottie/size_limit" type="int" setter="" getter="" default="4096">
If greater than [code]0[/code], the size of the rendered texture will be limited to less than or equal to this value. Otherwise, the size of the texture is unlimited and follows the original size and frame count.
</member>
<member name="lottie/size_scale" type="float" setter="" getter="" default="1.0">
The resolution scale the Lottie should be rendered at, with [code]1.0[/code] being the original size. Higher values result in a larger texture, but it won't exceed the [member lottie/size_limit].
</member>
</members>
</class>
233 changes: 233 additions & 0 deletions modules/svg/editor/resource_importer_lottie.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,233 @@
/**************************************************************************/
/* resource_importer_lottie.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 "resource_importer_lottie.h"
Comment thread
beicause marked this conversation as resolved.
Outdated

#include "core/io/image.h"
#include "core/io/json.h"
#include "editor/file_system/editor_file_system.h"
#include "scene/resources/atlas_texture.h"
#include "scene/resources/portable_compressed_texture.h"
#include "scene/resources/sprite_frames.h"
#include "scene/scene_string_names.h"

#include <thorvg.h>

static Ref<Image> lottie_to_sprite_sheet(Ref<JSON> p_json, float p_begin, float p_end, float p_fps, int p_columns, float p_scale, int p_size_limit, Size2i *r_sprite_size, int *r_columns, int *r_frame_count) {
std::unique_ptr<tvg::SwCanvas> sw_canvas = tvg::SwCanvas::gen();
std::unique_ptr<tvg::Animation> animation = tvg::Animation::gen();
tvg::Picture *picture = animation->picture();
tvg::Result res = sw_canvas->push(tvg::cast(picture));
ERR_FAIL_COND_V(res != tvg::Result::Success, Ref<Image>());

String lottie_str = p_json->get_parsed_text();
if (lottie_str.is_empty()) {
// Set `p_sort_keys` to false, otherwise ThorVG can't load it.
lottie_str = JSON::stringify(p_json->get_data(), "", false);
}

res = picture->load(lottie_str.utf8().get_data(), lottie_str.utf8().size(), "lottie", true);
ERR_FAIL_COND_V_MSG(res != tvg::Result::Success, Ref<Image>(), "Failed to load Lottie.");

float origin_width, origin_height;
picture->size(&origin_width, &origin_height);

p_end = CLAMP(p_end, p_begin, 1);
int total_frame_count = animation->totalFrame();
int frame_count = MAX(1, animation->duration() * CLAMP(p_end - p_begin, 0, 1) * p_fps);
int sheet_columns = p_columns <= 0 ? Math::ceil(Math::sqrt((float)frame_count)) : p_columns;
int sheet_rows = Math::ceil(((float)frame_count) / sheet_columns);
Vector2 texture_size = Vector2(origin_width * sheet_columns, origin_height * sheet_rows) * p_scale;

const uint32_t max_dimension = 16384;
if (p_size_limit <= 0) {
p_size_limit = max_dimension;
}
if (texture_size[texture_size.max_axis_index()] > p_size_limit) {
p_scale = p_size_limit / MAX(origin_width * sheet_columns, origin_height * sheet_rows);
}
uint32_t width = MAX(1, Math::round(origin_width * p_scale));
uint32_t height = MAX(1, Math::round(origin_height * p_scale));
picture->size(width, height);

LocalVector<uint32_t> buffer;
buffer.resize_initialized(width * height);

sw_canvas->sync();
res = sw_canvas->target(buffer.ptr(), width, width, height, tvg::SwCanvas::ARGB8888S);
if (res != tvg::Result::Success) {
ERR_FAIL_V_MSG(Ref<Image>(), "Couldn't set target on ThorVG canvas.");
}

Ref<Image> image = Image::create_empty(width * sheet_columns, height * sheet_rows, false, Image::FORMAT_RGBA8);

for (int row = 0; row < sheet_rows; row++) {
for (int column = 0; column < sheet_columns; column++) {
if (row * sheet_columns + column >= frame_count) {
break;
}
float progress = ((float)(row * sheet_columns + column)) / frame_count;
float current_frame = total_frame_count * (p_begin + (p_end - p_begin) * progress);

animation->frame(current_frame);
res = sw_canvas->update(picture);
if (res != tvg::Result::Success) {
ERR_FAIL_V_MSG(Ref<Image>(), "Couldn't update ThorVG pictures on canvas.");
}
res = sw_canvas->draw();
if (res != tvg::Result::Success) {
WARN_PRINT_ONCE("Couldn't draw ThorVG pictures on canvas.");
}
res = sw_canvas->sync();
if (res != tvg::Result::Success) {
ERR_FAIL_V_MSG(Ref<Image>(), "Couldn't sync ThorVG canvas.");
}

for (uint32_t y = 0; y < height; y++) {
for (uint32_t x = 0; x < width; x++) {
uint32_t n = buffer[y * width + x];
Color color;
color.set_r8((n >> 16) & 0xff);
color.set_g8((n >> 8) & 0xff);
color.set_b8(n & 0xff);
color.set_a8((n >> 24) & 0xff);
image->set_pixel(x + width * column, y + height * row, color);
}
}
sw_canvas->clear(false);
}
}
if (r_sprite_size) {
*r_sprite_size = Size2i(width, height);
}
if (r_columns) {
*r_columns = sheet_columns;
}
if (r_frame_count) {
*r_frame_count = frame_count;
}
return image;
}

String ResourceImporterLottie::get_importer_name() const {
return "lottie_sprite_frames";
}

String ResourceImporterLottie::get_visible_name() const {
Comment thread
beicause marked this conversation as resolved.
Outdated
return "SpriteFrames";
}

void ResourceImporterLottie::get_recognized_extensions(List<String> *p_extensions) const {
p_extensions->push_back("lot");
}

String ResourceImporterLottie::get_save_extension() const {
return "res";
}

String ResourceImporterLottie::get_resource_type() const {
return "SpriteFrames";
}

void ResourceImporterLottie::get_import_options(const String &p_path, List<ImportOption> *r_options, int p_preset) const {
Comment thread
beicause marked this conversation as resolved.
Outdated
r_options->push_back(ResourceImporter::ImportOption(PropertyInfo(Variant::INT, "lottie/size_limit", PROPERTY_HINT_RANGE, "0,4096,1,or_greater"), 4096));
r_options->push_back(ResourceImporter::ImportOption(PropertyInfo(Variant::FLOAT, "lottie/size_scale", PROPERTY_HINT_RANGE, "0,2,0.001,or_greater"), 1.0));
r_options->push_back(ResourceImporter::ImportOption(PropertyInfo(Variant::FLOAT, "lottie/frame_begin", PROPERTY_HINT_RANGE, "0,1,0.001"), 0));
r_options->push_back(ResourceImporter::ImportOption(PropertyInfo(Variant::FLOAT, "lottie/frame_end", PROPERTY_HINT_RANGE, "0,1,0.001"), 1));
r_options->push_back(ResourceImporter::ImportOption(PropertyInfo(Variant::FLOAT, "lottie/frame_rate", PROPERTY_HINT_RANGE, "0,60,0.1,or_greater"), 30));
r_options->push_back(ResourceImporter::ImportOption(PropertyInfo(Variant::INT, "lottie/columns", PROPERTY_HINT_RANGE, "0,16,1,or_greater"), 0));
r_options->push_back(ResourceImporter::ImportOption(PropertyInfo(Variant::INT, "lottie/image_handling", PROPERTY_HINT_ENUM, "Embed as Lossless,Embed as Basis Universal,Extract"), 0));
}

bool ResourceImporterLottie::get_option_visibility(const String &p_path, const String &p_option, const HashMap<StringName, Variant> &p_options) const {
return true;
}

Error ResourceImporterLottie::import(ResourceUID::ID p_source_id, const String &p_source_file, const String &p_save_path, const HashMap<StringName, Variant> &p_options, List<String> *r_platform_variants, List<String> *r_gen_files, Variant *r_metadata) {
Error err = OK;
Ref<JSON> lottie_json;
lottie_json.instantiate();
String Lottie_str = FileAccess::get_file_as_string(p_source_file, &err);
ERR_FAIL_COND_V(err != OK, err);
lottie_json->parse(Lottie_str, true);
ERR_FAIL_COND_V(lottie_json.is_null(), ERR_INVALID_DATA);

const int size_limit = p_options["lottie/size_limit"];
const float size_scale = p_options["lottie/size_scale"];
const float begin = p_options["lottie/frame_begin"];
const float end = p_options["lottie/frame_end"];
const float fps = p_options["lottie/frame_rate"];
int columns = p_options["lottie/columns"];
const int image_handling = p_options["lottie/image_handling"];

Size2i sprite_size;
int frame_count;
Ref<Image> image = lottie_to_sprite_sheet(lottie_json, begin, end, fps, columns, size_scale, size_limit, &sprite_size, &columns, &frame_count);
ERR_FAIL_COND_V(image.is_null(), ERR_INVALID_DATA);

Ref<Texture2D> texture;
if (image_handling == IMAGE_EMBED_LOSSLESS) {
Ref<PortableCompressedTexture2D> ctex;
ctex.instantiate();
ctex->create_from_image(image, PortableCompressedTexture2D::COMPRESSION_MODE_LOSSLESS);
texture = ctex;
} else if (image_handling == IMAGE_EMBED_BASIS_UNIVERSAL) {
Ref<PortableCompressedTexture2D> ctex;
ctex.instantiate();
ctex->create_from_image(image, PortableCompressedTexture2D::COMPRESSION_MODE_BASIS_UNIVERSAL);
texture = ctex;
} else if (image_handling == IMAGE_EXTRACT) {
String img_path = p_source_file.get_base_dir().path_join(p_source_file.get_file() + ".webp");
err = image->save_webp(img_path);
ERR_FAIL_COND_V(err != OK, err);

EditorFileSystem::get_singleton()->update_file(img_path);
EditorFileSystem::get_singleton()->reimport_append(img_path, HashMap<StringName, Variant>(), "", Variant());
texture = ResourceLoader::load(img_path, "Texture2D", ResourceFormatLoader::CACHE_MODE_IGNORE);
} else {
ERR_FAIL_V(ERR_INVALID_PARAMETER);
}
ERR_FAIL_COND_V(texture.is_null(), ERR_INVALID_DATA);

Ref<SpriteFrames> sprite_frames;
sprite_frames.instantiate();
sprite_frames->set_animation_speed(SceneStringName(default_), fps);
for (int i = 0; i < frame_count; i++) {
int x = i % columns * sprite_size.width;
int y = i / columns * sprite_size.height;
Ref<AtlasTexture> atlas_texture;
atlas_texture.instantiate();
atlas_texture->set_atlas(texture);
atlas_texture->set_region(Rect2(x, y, sprite_size.width, sprite_size.height));
sprite_frames->add_frame(SceneStringName(default_), atlas_texture);
}
err = ResourceSaver::save(sprite_frames, p_save_path + ".res");
return err;
}
55 changes: 55 additions & 0 deletions modules/svg/editor/resource_importer_lottie.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
/**************************************************************************/
/* resource_importer_lottie.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/resource_importer.h"

class ResourceImporterLottie : public ResourceImporter {
GDCLASS(ResourceImporterLottie, ResourceImporter);

enum {
IMAGE_EMBED_LOSSLESS,
IMAGE_EMBED_BASIS_UNIVERSAL,
IMAGE_EXTRACT,
};

public:
virtual String get_importer_name() const override;
virtual String get_visible_name() const override;
virtual void get_recognized_extensions(List<String> *p_extensions) const override;
virtual String get_save_extension() const override;
virtual String get_resource_type() const override;
virtual bool can_import_threaded() const override { return true; }

virtual void get_import_options(const String &p_path, List<ImportOption> *r_options, int p_preset = 0) const override;
virtual bool get_option_visibility(const String &p_path, const String &p_option, const HashMap<StringName, Variant> &p_options) const override;
virtual Error import(ResourceUID::ID p_source_id, const String &p_source_file, const String &p_save_path, const HashMap<StringName, Variant> &p_options, List<String> *r_platform_variants, List<String> *r_gen_files = nullptr, Variant *r_metadata = nullptr) override;
};
Loading
Loading