[FL-2150] Dolphin animation refactoring (#938)

* Dolphin Animation Refactoring, part 1
* Remove animations from desktop
* Remove excess, first start
* Split animation_manager with callbacks
* allocate view inside animation_view
* Work on ViewComposed
* Draw white rectangles under bubble corners
* Fix bubbles sequence
* RPC: remove obsolete include "status.pb.h"
* Add animations manifest decoding
* Flipper file: add strict mode
* FFF: Animation structures parsing
* Assembling structure of animation
* Lot of view fixes:
  Add multi-line bubbles
  Add support for passive bubbles (frame_order values starts from passive now)
  Add hard-coded delay (active_shift) for active state enabling
  Fix active state handling
  Fix leaks
  Fix parsing uncorrect bubble_animation meta file
  Fix bubble rules of showing
* Animation load/unload & view freeze/unfreeze
* Blocking & system animations, fixes:
  View correct activation
  Refactoring + blocking animation
  Freeze first passive/active frames
  Many insert/eject SD tests fixes
  Add system animations
  Add Loader events app started/finished
  Add system no_sd animation
* Assets: dolphin packer. Scripts: minor refactoring.
* Desktop: update logging tags. Scripts: add metadata to dolphin bundling process, extra sorting for fs traversing. Make: phony assets rules.
* Github: rebuild assets on build
* Docker: add missing dependencies for assets compilation
* Docker: fix run command syntax
* ReadMe: update naming rules with link to source
* Assets: recompile icons
* Loader: add loader event
* Desktop, Gui, Furi Core: const shenanigans macros

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>

scripts/assets.py

@@ -52,6 +52,17 @@ class Main:
         self.parser_copro.add_argument("mcu", help="MCU series as in copro folder")
         self.parser_copro.set_defaults(func=self.copro)
 
+        self.parser_dolphin = self.subparsers.add_parser(
+            "dolphin", help="Assemble dolphin resources"
+        )
+        self.parser_dolphin.add_argument(
+            "dolphin_sources", help="Doplhin sources directory"
+        )
+        self.parser_dolphin.add_argument(
+            "dolphin_output", help="Doplhin output directory"
+        )
+        self.parser_dolphin.set_defaults(func=self.dolphin)
+
         # logging
         self.logger = logging.getLogger()
 
@@ -79,6 +90,7 @@ class Main:
         for dirpath, dirnames, filenames in os.walk(self.args.source_directory):
             self.logger.debug(f"Processing directory {dirpath}")
             dirnames.sort()
+            filenames.sort()
             if not filenames:
                 continue
             if "frame_rate" in filenames:
@@ -193,7 +205,7 @@ class Main:
         return extension in ICONS_SUPPORTED_FORMATS
 
     def manifest(self):
-        from flipper.manifest import Manifest
+        from flipper.assets.manifest import Manifest
 
         directory_path = os.path.normpath(self.args.local_path)
         if not os.path.isdir(directory_path):
@@ -222,12 +234,17 @@ class Main:
         self.logger.info(f"Complete")
 
     def copro(self):
-        from flipper.copro import Copro
+        from flipper.assets.copro import Copro
 
         copro = Copro(self.args.mcu)
         copro.loadCubeInfo(self.args.cube_dir)
         copro.bundle(self.args.output_dir)
 
+    def dolphin(self):
+        from flipper.assets.dolphin import pack_dolphin
+
+        pack_dolphin(self.args.dolphin_sources, self.args.dolphin_output)
+
 
 if __name__ == "__main__":
     Main()()

scripts/flipper/assets/copro.py

@@ -4,7 +4,7 @@ import shutil
 import json
 
 import xml.etree.ElementTree as ET
-from .utils import *
+from flipper.utils import *
 
 CUBE_COPRO_PATH = "Projects/STM32WB_Copro_Wireless_Binaries"
 

scripts/flipper/assets/dolphin.py

@@ -0,0 +1,55 @@
+import multiprocessing
+import logging
+import os
+import sys
+import shutil
+
+from .icon import *
+
+
+def _pack_animation(pair: set):
+    source, destination = pair
+    image = file2image(source)
+    image.write(destination)
+
+
+def pack_animations(source: str, destination: str):
+    assert os.path.exists(source)
+    # Create list for processing
+    to_pack = []
+    dirpath, dirnames = next(os.walk(source))[:2]
+    dirnames.sort()
+    for dirname in dirnames:
+        current_directory = os.path.join(dirpath, dirname)
+        # Ensure destination folder
+        destination_directory = os.path.join(destination, dirname)
+        os.makedirs(destination_directory, exist_ok=True)
+        # Find all files
+        filenames = next(os.walk(current_directory))[2]
+        filenames.sort()
+        for filename in filenames:
+            if is_file_an_icon(filename):
+                source_filename = os.path.join(current_directory, filename)
+                destination_filename = os.path.join(
+                    destination_directory, os.path.splitext(filename)[0] + ".bm"
+                )
+                to_pack.append((source_filename, destination_filename))
+            elif filename == "meta.txt":
+                source_filename = os.path.join(current_directory, filename)
+                destination_filename = os.path.join(destination_directory, filename)
+                shutil.copyfile(source_filename, destination_filename)
+
+    # Process images in parallel
+    pool = multiprocessing.Pool()
+    pool.map(_pack_animation, to_pack)
+
+    shutil.copyfile(
+        os.path.join(source, "manifest.txt"), os.path.join(destination, "manifest.txt")
+    )
+
+
+def pack_dolphin(source_directory: str, destination_directory: str):
+    pack_animations(
+        os.path.join(source_directory, "animations"),
+        os.path.join(destination_directory, "animations"),
+    )

scripts/flipper/assets/icon.py

@@ -0,0 +1,56 @@
+import logging
+import argparse
+import subprocess
+import io
+import os
+import sys
+
+ICONS_SUPPORTED_FORMATS = ["png"]
+
+
+class Image:
+    def __init__(self, width: int, height: int, data: bytes):
+        self.width = width
+        self.height = height
+        self.data = data
+
+    def write(self, filename):
+        file = open(filename, "wb")
+        file.write(self.data)
+
+
+def is_file_an_icon(filename):
+    extension = filename.lower().split(".")[-1]
+    return extension in ICONS_SUPPORTED_FORMATS
+
+
+def file2image(file):
+    output = subprocess.check_output(["convert", file, "xbm:-"])
+    assert output
+
+    # Extract data from text
+    f = io.StringIO(output.decode().strip())
+    width = int(f.readline().strip().split(" ")[2])
+    height = int(f.readline().strip().split(" ")[2])
+    data = f.read().strip().replace("\n", "").replace(" ", "").split("=")[1][:-1]
+    data_str = data[1:-1].replace(",", " ").replace("0x", "")
+
+    data_bin = bytearray.fromhex(data_str)
+
+    # Encode icon data with LZSS
+    data_encoded_str = subprocess.check_output(
+        ["heatshrink", "-e", "-w8", "-l4"], input=data_bin
+    )
+
+    assert data_encoded_str
+
+    data_enc = bytearray(data_encoded_str)
+    data_enc = bytearray([len(data_enc) & 0xFF, len(data_enc) >> 8]) + data_enc
+
+    # Use encoded data only if its lenght less than original, including header
+    if len(data_enc) < len(data_bin) + 1:
+        data = b"\x01\x00" + data_enc
+    else:
+        data = b"\x00" + data_bin
+
+    return Image(width, height, data)

scripts/flipper/assets/manifest.py

@@ -2,8 +2,8 @@ import datetime
 import logging
 import os
 
-from .utils import *
-from .fstree import *
+from flipper.utils import *
+from flipper.utils.fstree import *
 
 MANIFEST_VERSION = 0