Lottie library for LVGL

This repository is merged into the lvgl repository. See https://docs.lvgl.io/master/libs/rlottie.html

Allows to use Rlottie animations in LVGL. Taken from base repository Uses Samsung/rlottie library with C-api header.

Rlottie build requires C++14-compatible compiler, optionally CMake 3.14.

Build setup

lv_lib_rottile can be built with CMake.

Download or clone this repository with git clone https://github.com/lvgl/lv_lib_rlottie.git --recurse-submodules next to the lvgl folder. If you have downlaoded it run git submodule update --init for fetching the dependencies.
In you CMakeFile.txt

add:

set(LOTTIE_MODULE OFF)
set(LOTTIE_THREAD OFF)
set(BUILD_SHARED_LIBS OFF)

include lv_lib_rlotties CMakeFile with include(${CMAKE_CURRENT_SOURCE_DIR}/lv_lib_rlottie/CMakeLists.txt)
link lv_lib_rlottie with your target. E.g. target_link_libraries(my_target PRIVATE lv_lib_rlottie)

Example CMakeList

An example CMakeList.txt file that builds lvgl, lv_demos, lv_driver and lv_lib_rlottie with SDL can look like tihs:

cmake_minimum_required(VERSION 3.10)
project(lvgl)
set(CMAKE_C_STANDARD 11)#C11
set(CMAKE_CXX_STANDARD 17)#C17
set(CMAKE_CXX_STANDARD_REQUIRED ON)

INCLUDE_DIRECTORIES(${PROJECT_SOURCE_DIR})

file(GLOB_RECURSE INCLUDES "lv_drivers/*.h" "lv_demos/*.h"  "lvgl/*.h"  "./*.h" )
file(GLOB_RECURSE SOURCES  "lv_drivers/*.c" "lv_demos/*.c"  "lvgl/*.c" )

include(${CMAKE_CURRENT_SOURCE_DIR}/lv_lib_rlottie/CMakeLists.txt)

SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin) 
SET(CMAKE_CXX_FLAGS "-O3")

find_package(SDL2 REQUIRED SDL2)
include_directories(${SDL2_INCLUDE_DIRS})
add_executable(main main.c lv_lib_rlottie/lv_rlottie_example_fingerprint.c ${SOURCES} ${INCLUDES})
add_compile_definitions(LV_CONF_INCLUDE_SIMPLE)
target_link_libraries(main PRIVATE SDL2 lv_lib_rlottie)
add_custom_target (run COMMAND ${EXECUTABLE_OUTPUT_PATH}/main)

Usage

You can use animation from raw data (text) or files. In either case first include lv_lib_rlottie/lv_rlottie.h.

The width and height os the object be set in the craete function. The animation will be scaled accordingly.

Use Rlottie from raw string data

lv_rlottie_example_fingerprint.c contains an example animation in raw string format. It can be used like this:

extern const char FingerprintRaw[];
lv_obj_t* r1 = lv_rlottie_create_from_raw(parent, width, height, FingerprintRaw);

JSON escaping

For using raw strings it's necessary to escape an image data. For this purpose the following escape tool can be used: https://www.freeformatter.com/json-escape.html

Use Rlottie from external file

You can use card.json at first:

  lv_obj_t* r2 = lv_rlottie_create_from_file(lv_scr_act(), width, height, "../lv_lib_rlottie/card.json");

Getting aniamtions

Lottie is standard and popular format so you can find many animation files on the web. For example: https://lottiefiles.com/

You can also create your own animations with Adobe After Effects or similar software.

lvgl / lv_lib_rlottie