[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/flipper/assets/copro.py

@@ -0,0 +1,95 @@
+import logging
+import datetime
+import shutil
+import json
+
+import xml.etree.ElementTree as ET
+from flipper.utils import *
+
+CUBE_COPRO_PATH = "Projects/STM32WB_Copro_Wireless_Binaries"
+
+MANIFEST_TEMPLATE = {
+    "manifest": {"version": 0, "timestamp": 0},
+    "copro": {
+        "fus": {"version": {"major": 1, "minor": 2, "sub": 0}, "files": []},
+        "radio": {
+            "version": {
+                "type": 3,
+                "major": 1,
+                "minor": 13,
+                "sub": 0,
+                "branch": 0,
+                "release": 5,
+            },
+            "files": [],
+        },
+    },
+}
+
+
+class Copro:
+    def __init__(self, mcu):
+        self.mcu = mcu
+        self.version = None
+        self.cube_dir = None
+        self.mcu_copro = None
+        self.logger = logging.getLogger(self.__class__.__name__)
+
+    def loadCubeInfo(self, cube_dir):
+        if not os.path.isdir(cube_dir):
+            raise Exception(f'"{cube_dir}" doesn\'t exists')
+        self.cube_dir = cube_dir
+        self.mcu_copro = os.path.join(self.cube_dir, CUBE_COPRO_PATH, self.mcu)
+        if not os.path.isdir(self.mcu_copro):
+            raise Exception(f'"{self.mcu_copro}" doesn\'t exists')
+        cube_manifest_file = os.path.join(self.cube_dir, "package.xml")
+        cube_manifest = ET.parse(cube_manifest_file)
+        cube_package = cube_manifest.find("PackDescription")
+        if not cube_package:
+            raise Exception(f"Unknown Cube manifest format")
+        cube_version = cube_package.get("Patch") or cube_package.get("Release")
+        if not cube_version or not cube_version.startswith("FW.WB"):
+            raise Exception(f"Incorrect Cube package or version info")
+        cube_version = cube_version.replace("FW.WB.", "", 1)
+        if cube_version != "1.13.1":
+            raise Exception(f"Unknonwn cube version")
+        self.version = cube_version
+
+    def addFile(self, array, filename, **kwargs):
+        source_file = os.path.join(self.mcu_copro, filename)
+        destination_file = os.path.join(self.output_dir, filename)
+        shutil.copyfile(source_file, destination_file)
+        array.append(
+            {"name": filename, "sha256": file_sha256(destination_file), **kwargs}
+        )
+
+    def bundle(self, output_dir):
+        if not os.path.isdir(output_dir):
+            raise Exception(f'"{output_dir}" doesn\'t exists')
+        self.output_dir = output_dir
+        manifest_file = os.path.join(self.output_dir, "Manifest.json")
+        # Form Manifest
+        manifest = dict(MANIFEST_TEMPLATE)
+        manifest["manifest"]["timestamp"] = timestamp()
+        # Old FUS Update
+        self.addFile(
+            manifest["copro"]["fus"]["files"],
+            "stm32wb5x_FUS_fw_for_fus_0_5_3.bin",
+            condition="==0.5.3",
+            address="0x080EC000",
+        )
+        # New FUS Update
+        self.addFile(
+            manifest["copro"]["fus"]["files"],
+            "stm32wb5x_FUS_fw.bin",
+            condition=">0.5.3",
+            address="0x080EC000",
+        )
+        # BLE Full Stack
+        self.addFile(
+            manifest["copro"]["radio"]["files"],
+            "stm32wb5x_BLE_Stack_light_fw.bin",
+            address="0x080D7000",
+        )
+        # Save manifest to
+        json.dump(manifest, open(manifest_file, "w"))

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

@@ -0,0 +1,168 @@
+import datetime
+import logging
+import os
+
+from flipper.utils import *
+from flipper.utils.fstree import *
+
+MANIFEST_VERSION = 0
+
+
+class ManifestRecord:
+    tag = None
+
+    @staticmethod
+    def fromLine(line):
+        raise NotImplementedError
+
+    def toLine(self):
+        raise NotImplementedError
+
+    def _unpack(self, manifest, key, type):
+        key, value = manifest.readline().split(":", 1)
+        assert key == key
+        return type(value)
+
+
+MANIFEST_TAGS_RECORDS = {}
+
+
+def addManifestRecord(record: ManifestRecord):
+    assert record.tag
+    MANIFEST_TAGS_RECORDS[record.tag] = record
+
+
+class ManifestRecordVersion(ManifestRecord):
+    tag = "V"
+
+    def __init__(self, version):
+        self.version = version
+
+    @staticmethod
+    def fromLine(line):
+        return ManifestRecordVersion(int(line))
+
+    def toLine(self):
+        return f"{self.tag}:{self.version}\n"
+
+
+addManifestRecord(ManifestRecordVersion)
+
+
+class ManifestRecordTimestamp(ManifestRecord):
+    tag = "T"
+
+    def __init__(self, timestamp: int):
+        self.timestamp = int(timestamp)
+
+    @staticmethod
+    def fromLine(line):
+        return ManifestRecordTimestamp(int(line))
+
+    def toLine(self):
+        return f"{self.tag}:{self.timestamp}\n"
+
+
+addManifestRecord(ManifestRecordTimestamp)
+
+
+class ManifestRecordDirectory(ManifestRecord):
+    tag = "D"
+
+    def __init__(self, path: str):
+        self.path = path
+
+    @staticmethod
+    def fromLine(line):
+        return ManifestRecordDirectory(line)
+
+    def toLine(self):
+        return f"{self.tag}:{self.path}\n"
+
+
+addManifestRecord(ManifestRecordDirectory)
+
+
+class ManifestRecordFile(ManifestRecord):
+    tag = "F"
+
+    def __init__(self, path: str, md5: str, size: int):
+        self.path = path
+        self.md5 = md5
+        self.size = size
+
+    @staticmethod
+    def fromLine(line):
+        data = line.split(":", 3)
+        return ManifestRecordFile(data[2], data[0], data[1])
+
+    def toLine(self):
+        return f"{self.tag}:{self.md5}:{self.size}:{self.path}\n"
+
+
+addManifestRecord(ManifestRecordFile)
+
+
+class Manifest:
+    def __init__(self):
+        self.version = None
+        self.records = []
+        self.records.append(ManifestRecordVersion(MANIFEST_VERSION))
+        self.records.append(ManifestRecordTimestamp(timestamp()))
+        self.logger = logging.getLogger(self.__class__.__name__)
+
+    def load(self, filename):
+        manifest = open(filename, "r")
+        for line in manifest.readlines():
+            line = line.strip()
+            if len(line) == 0:
+                continue
+            tag, line = line.split(":", 1)
+            record = MANIFEST_TAGS_RECORDS[tag].fromLine(line)
+            self.records.append(record)
+
+    def save(self, filename):
+        manifest = open(filename, "w+")
+        for record in self.records:
+            manifest.write(record.toLine())
+        manifest.close()
+
+    def addDirectory(self, path):
+        self.records.append(ManifestRecordDirectory(path))
+
+    def addFile(self, path, md5, size):
+        self.records.append(ManifestRecordFile(path, md5, size))
+
+    def create(self, directory_path):
+        for root, dirs, files in os.walk(directory_path):
+            relative_root = root.replace(directory_path, "", 1)
+            if relative_root.startswith("/"):
+                relative_root = relative_root[1:]
+            # process directories
+            for dir in dirs:
+                relative_dir_path = os.path.join(relative_root, dir)
+                self.logger.info(f'Adding directory: "{relative_dir_path}"')
+                self.addDirectory(relative_dir_path)
+            # Process files
+            for file in files:
+                relative_file_path = os.path.join(relative_root, file)
+                full_file_path = os.path.join(root, file)
+                self.logger.info(f'Adding file: "{relative_file_path}"')
+                self.addFile(
+                    relative_file_path,
+                    file_md5(full_file_path),
+                    os.path.getsize(full_file_path),
+                )
+
+    def toFsTree(self):
+        root = FsNode("", FsNode.Type.Directory)
+        for record in self.records:
+            if isinstance(record, ManifestRecordDirectory):
+                root.addDirectory(record.path)
+            elif isinstance(record, ManifestRecordFile):
+                root.addFile(record.path, record.md5, record.size)
+        return root
+
+    @staticmethod
+    def compare(left: "Manifest", right: "Manifest"):
+        return compare_fs_trees(left.toFsTree(), right.toFsTree())