App:Library:LVGL:docs:3rd party libraries:Lottie player

提供: robot-jp wiki
ナビゲーションに移動検索に移動

https://docs.lvgl.io/8.2/libs/rlottie.html

Lottie player

英文 自動翻訳

Allows to use Lottie animations in LVGL. Taken from this base repository

LVGL provides the interface to Samsung/rlottie library's C API. That is the actual Lottie player is not part of LVGL, it needs to be built separately.

LVGLでロッティアニメーションを使用できます。このベースリポジトリから取得

LVGLは、Samsung/rlottieライブラリのCAPIへのインターフェイスを提供します。つまり、実際のLottieプレーヤーはLVGLの一部ではなく、個別に構築する必要があります。

戻る : Previous


Build Rlottie

英文 自動翻訳

To build Samsung's Rlottie C++14-compatible compiler and optionally CMake 3.14 or higher is required.

To build on desktop you can follow the instructions from Rlottie's README. In the most basic case it looks like this:

 mkdir rlottie_workdir
 cd rlottie_workdir
 git clone <nowiki>https://github.com/Samsung/rlottie.git</nowiki>
 mkdir build
 cd build
 cmake ../rlottie
 make -j
 sudo make install

And finally add the -lrlottie flag to your linker.

On embedded systems you need to take care of integrating Rlottie to the given build system.

SamsungのRlottieC++ 14互換コンパイラをビルドするには、オプションでCMake3.14以降が必要です。

デスクトップ上に構築するには、RlottieのREADMEの指示に従うことができます。最も基本的なケースでは、次のようになります。

 mkdir rlottie_workdir
 cd rlottie_workdir
 git clone <nowiki>https://github.com/Samsung/rlottie.git</nowiki>
 mkdirビルド
 cdビルド
 cmake ../rlottie
 make -j
 sudo make install

そして最後に、-lrlottieフラグをリンカーに追加します。

組み込みシステムでは、Rlottieを特定のビルドシステムに統合する必要があります。

戻る : Previous


Usage

英文 自動翻訳

You can use animation from files or raw data (text).

In either case first you need to enable LV_USE_RLOTTIE in lv_conf.h.

The width and height of the object be set in the create function and the animation will be scaled accordingly.

ファイルや生データ(テキスト)からのアニメーションを使用することができます。

どちらの場合でも、まずlv_conf.hLV_USE_RLOTTIE を有効にする必要があります。

オブジェクトのwidthheightはcreate関数で設定され、アニメーションはそれに応じて拡大縮小されます。

戻る : Previous


Use Rlottie from file

英文 自動翻訳

To create a Lottie animation from file use:

 
  lv_obj_t * lottie = lv_rlottie_create_from_file(parent, width, height, "path/to/lottie.json");


Note that, Rlottie uses the standard STDIO C file API, so you can use the path "normally" and no LVGL specific driver letter is required.

ファイルからロッティアニメーションを作成するには、次のようにします。
 
  lv_obj_t * lottie = lv_rlottie_create_from_fileparentwidthheight "path / to / lottie.json";


なお、Rlottieは標準のSTDIO CファイルAPIを使用しているので、パスは「普通に」使用でき、LVGL固有のドライバ文字は必要ありません。

戻る : Previous


Use Rlottie from raw string data

英文 自動翻訳

lv_example_rlottie_approve.c contains an example animation in raw format. Instead storing the JSON string a hex array is stored for the following reasons:

  • avoid escaping " in the JSON file
  • some compilers don't support very long strings


lvgl/scripts/filetohex.py can be used to convert a Lottie file a hex array. E.g.:

 ./filetohex.py path/to/lottie.json > out.txt


To create an animation from raw data:

 extern const uint8_t lottie_data[];
 lv_obj_t* lottie = lv_rlottie_create_from_raw(parent, width, height, (const char *)lottie_data);

lv_example_rlottie_approve.c は、raw 形式のアニメーション例を含んでいます。以下の理由から、JSON文字列の代わりに16進配列が格納されています。

  • JSONファイル中の"のエスケープを避けるため。
  • コンパイラによっては、非常に長い文字列をサポートしない場合があります。


lvgl/scripts/filetohex.py は、Lottieファイルを16進配列に変換するために使用されます。

例:
 ./filetohex.py path / to / lottie.json> out.txt


生データからアニメーションを作成するには:

 extern const uint8_t lottie_data [];
 lv_obj_t * lottie = lv_rlottie_create_from_rawparentwidthheight、(const char *lottie_data;
戻る : Previous


Getting animations

英文 自動翻訳

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.

Lottieは標準的で一般的なフォーマットなので、ウェブ上で多くのアニメーションファイルを見つけることができます。


例: https://lottiefiles.com/


また、Adobe After Effectsなどを使って、自分でアニメーションを作成することもできます。

戻る : Previous


Controlling animations

英文 自動翻訳

LVGL provides two functions to control the animation mode: lv_rlottie_set_play_mode and lv_rlottie_set_current_frame.


You'll combine your intentions when calling the first method, like in these examples:

 
lv_obj_t * lottie = lv_rlottie_create_from_file(scr, 128, 128, "test.json");
 lv_obj_center(lottie);
 // Pause to a specific frame
 lv_rlottie_set_current_frame(lottie, 50);
 lv_rlottie_set_play_mode(lottie, LV_RLOTTIE_CTRL_PAUSE); // The specified frame will be displayed and then the animation will pause
 
 // Play backward and loop
 lv_rlottie_set_play_mode(lottie, LV_RLOTTIE_CTRL_PLAY | LV_RLOTTIE_CTRL_BACKWARD | LV_RLOTTIE_CTRL_LOOP);
 
 // Play forward once (no looping)
 lv_rlottie_set_play_mode(lottie, LV_RLOTTIE_CTRL_PLAY | LV_RLOTTIE_CTRL_FORWARD);


The default animation mode is play forward with loop.

If you don't enable looping, a LV_EVENT_READY is sent when the animation can not make more progress without looping.

To get the number of frames in an animation or the current frame index, you can cast the lv_obj_t instance to a lv_rlottie_t instance and inspect the current_frame and total_frames members.

LVGLはアニメーションモードを制御するために、lv_rlottie_set_play_modelv_rlottie_set_current_frameという2つの関数を提供しています。


これらの例のように、最初のメソッドを呼び出すときに、あなたの意図を組み合わせることになります。
 lv_obj_t * lottie = lv_rlottie_create_from_filescr128128 "test.json";
 lv_obj_centerlottie;
 //特定のフレームに一時停止します
 lv_rlottie_set_current_framelottie50;
 lv_rlottie_set_play_modelottieLV_RLOTTIE_CTRL_PAUSE; //指定したフレームが表示され、アニメーションが一時停止します
 
 //逆方向に再生してループします
 lv_rlottie_set_play_modelottieLV_RLOTTIE_CTRL_PLAY | LV_RLOTTIE_CTRL_BACKWARD | LV_RLOTTIE_CTRL_LOOP;
 
 // 1回前方に再生します(ループなし)
 lv_rlottie_set_play_modelottieLV_RLOTTIE_CTRL_PLAY | LV_RLOTTIE_CTRL_FORWARD;

デフォルトのアニメーションモードは、ループ再生です。


ループを有効にしない場合、アニメーションがループせずにそれ以上進めなくなると、LV_EVENT_READYが送信されます。


アニメーションのフレーム数や現在のフレームインデックスを取得するには、lv_obj_t インスタンスをlv_rlottie_t インスタンスにキャストし、 current_frametotal_frames のメンバを検査することができます。

戻る : Previous


Example

英文 自動翻訳

Load a Lottie animation from raw data

LVGL docs 3rdPartyLibs Lottie 01.png

Load a Lottie animation from a file

LVGL docs 3rdPartyLibs Lottie 01.png

戻る : Previous


API

英文 自動翻訳

Enums

enum lv_rlottie_ctrl_t

Values:
enumerator LV_RLOTTIE_CTRL_FORWARD
enumerator LV_RLOTTIE_CTRL_BACKWARD
enumerator LV_RLOTTIE_CTRL_PAUSE
enumerator LV_RLOTTIE_CTRL_PLAY
enumerator LV_RLOTTIE_CTRL_LOOP

Functions

lv_obj_t *lv_rlottie_create_from_file(lv_obj_t *parent, lv_coord_t width, lv_coord_t height, const char *path)

lv_obj_t *lv_rlottie_create_from_raw(lv_obj_t *parent, lv_coord_t width, lv_coord_t height, const char *rlottie_desc)

void lv_rlottie_set_play_mode(lv_obj_t *rlottie, const lv_rlottie_ctrl_t ctrl)

void lv_rlottie_set_current_frame(lv_obj_t *rlottie, const size_t goto_frame)

Variables

const lv_obj_class_t lv_rlottie_class

struct lv_rlottie_t

Public Members
lv_img_t img_ext
struct Lottie_Animation_S *animation
lv_timer_t *task
lv_img_dsc_t imgdsc
size_t total_frames
size_t current_frame
size_t framerate
uint32_t *allocated_buf
size_t allocated_buffer_size
size_t scanline_width
lv_rlottie_ctrl_t play_ctrl
size_t dest_frame


列挙型

列挙型lv_rlottie_ctrl_t

値:
列挙子LV_RLOTTIE_CTRL_FORWARD
列挙子LV_RLOTTIE_CTRL_BACKWARD
列挙子LV_RLOTTIE_CTRL_PAUSE
列挙子LV_RLOTTIE_CTRL_PLAY
列挙子LV_RLOTTIE_CTRL_LOOP

機能

lv_obj_t * lv_rlottie_create_from_file(lv_obj_t * parent、lv_coord_t width、lv_coord_t height、const char * path)

lv_obj_t * lv_rlottie_create_from_raw(lv_obj_t * parent、lv_coord_t width、lv_coord_t height、const char * rlottie_desc)

void lv_rlottie_set_play_mode(lv_obj_t * rlottie、const lv_rlottie_ctrl_t ctrl)

void lv_rlottie_set_current_frame(lv_obj_t * rlottie、const size_t goto_frame)

変数

const lv_obj_class_t lv_rlottie_class

struct lv_rlottie_t

パブリックメンバー
lv_img_t img_ext
structLottie_Animation_S*アニメーション
lv_timer_t * task
lv_img_dsc_t imgdsc
size_t total_frames
size_t current_frame
size_tフレームレート
uint32_t * allocated_buf
size_tassigned_buffer_size
size_t scanline_width
lv_rlottie_ctrl_t play_ctrl
size_t dest_frame


戻る : Previous