refactor: the decode method is split into several small functions, some logging info changed

renaming: the term cutting is replaced with rendering objects

Author: danila-schelkov

.flake8

@@ -13,7 +13,8 @@ repos:
     hooks:
       - id: black
         language_version: python3.10
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.0.261'
     hooks:
-      - id: flake8
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]

.pre-commit-config.yaml

@@ -48,11 +48,11 @@
     "clean_dirs_description": "Clear In and Out dirs",
 
     "not_latest": "Not the latest version installed",
-    "collecting_inf": "Collecting information...",
+    "collecting_inf": "File: %s. Collecting information...",
     "about_sc": "About texture. Filename: %s (%d), Pixel type: %d, Size: %sx%s",
     "decompression_error": "Error while decompressing! Trying to decode as is...",
     "skip_not_installed": "%s isn't installed! Reinitialize",
-    "detected_comp": "Detected %s compression!",
+    "detected_comp": "%s compression detected",
     "unk_type": "Unknown pixel type: %s",
     "crt_pic": "Creating picture...",
     "join_pic": "Joining picture...",
@@ -73,7 +73,6 @@
     "cut_sprites_process": "Cutting sprites... (%d/%d)",
     "place_sprites_process": "Placing sprites... (%d/%d)",
     "not_implemented": "This feature will be added in future updates.\nYou can follow XCoder updates here: github.com/Vorono4ka/XCoder",
-    "dec_sc": "Decoding .sc file...",
     "error": "ERROR! (%s.%s: %s)",
     "e1sc1": "Overwrite SC sprites",
 	"cgl": "Changelog:\n%s",
@@ -88,4 +87,4 @@
     "disabled": "Disabled",
 
     "install_to_unlock": "Install '%s' to unlock more functions!"
-}
+}

system/languages/en-EU.json

@@ -48,11 +48,11 @@
     "clean_dirs_description": "Очистить In и Out папки",
 
     "not_latest": "Установлена не последняя версия",
-    "collecting_inf": "Сбор информации...",
+    "collecting_inf": "Файл: %s. Сбор информации...",
     "about_sc": "О текстуре. Файл: %s (%d), Тип пикселя: %d, Размеры: %dx%d",
     "decompression_error": "Ошибка распаковки! Проведите повторную инициализацию!",
     "skip_not_installed": "%s не установлен! Пропускаем...",
-    "detected_comp": "Обнаружено %s сжатие!",
+    "detected_comp": "Обнаружено сжатие: %s",
     "unk_type": "Неизвестный подтип: %s",
     "crt_pic": "Создаём картинку...",
     "join_pic": "Соединяем картинку...",
@@ -73,7 +73,6 @@
     "cut_sprites_process": "Вырезаем спрайты... (%d/%d)",
     "place_sprites_process": "Ставим спрайты на место... (%d/%d)",
     "not_implemented": "Данная возможность будет добавлена в будущих обновлениях.\nЗа обновлениями XCoder вы можете следить здесь: github.com/Vorono4ka/XCoder",
-    "dec_sc": "Декодируем SC...",
     "error": "ОШИБКА! (%s.%s: %s)",
     "e1sc1": "Перезапись спрайтов",
 	"cgl": "Список изменений: \n%s",
@@ -88,4 +87,4 @@
     "disabled": "Выключено",
 
     "install_to_unlock": "Установите '%s' чтобы открыть больше функций!"
-}
+}

system/languages/ru-RU.json

@@ -48,11 +48,11 @@
     "clean_dirs_description": "Очистити папки і файли в них",
 
     "not_latest": "Встановлена не остання версія",
-    "collecting_inf": "Збираємо інформацію...",
+    "collecting_inf": "Файл: %s. Збираємо інформацію...",
     "about_sc": "Про текстуру. Назва файлу: %s (%d), Тип пікселів: %d, Величина: %sx%s",
     "decompression_error": "Помилка при розпакуванні! Намагаємся розпакувати як є...",
     "skip_not_installed": "%s не встановлений, повторіть налаштування",
-    "detected_comp": "Виявлено %s компресію!",
+    "detected_comp": "Виявлено компресію: %s",
     "unk_type": "Невідомий вид пікселів: %s",
     "crt_pic": "Створюємо зоображеня...",
     "join_pic": "З'єднуємо зоображення...",
@@ -73,7 +73,6 @@
     "cut_sprites_process": "Обрізаємо спрайти... (%d/%d)",
     "place_sprites_process": "Вставляємо спрайти... (%d/%d)",
     "not_implemented": "Ця функція буде додана у наступних оновленнях.\nТи можеш сладкувати за оновленнями тут: github.com/Vorono4ka/XCoder",
-    "dec_sc": "Розпаковуємо .sc файл...",
     "error": "Помилка! (%s.%s: %s)",
     "e1sc1": "Переписати SC спрайти",
 	"cgl": "Список змін:\n%s",
@@ -88,4 +87,4 @@
     "disabled": "Виключено",
 
     "install_to_unlock": "Встанови '%s' щоб розблокувати більше функції!"
-}
+}

system/languages/ua-UA.json

@@ -1,17 +1,17 @@
 import sys
 import time
 
+from loguru import logger
+
 from system import clear
 from system.lib.config import config
 from system.lib.console import Console
 from system.lib.features.directories import clear_directories
 from system.lib.features.initialization import initialize
-from system.lib.features.update.check import check_update, check_for_outdated, get_tags
-from system.lib.menu import menu, Menu
+from system.lib.features.update.check import check_for_outdated, check_update, get_tags
+from system.lib.menu import Menu, menu
 from system.localization import locale
 
-from loguru import logger
-
 logger.remove()
 logger.add(
     "./logs/info/{time:YYYY-MM-DD}.log",
@@ -73,14 +73,20 @@ def refill_menu():
 
             del PIL
 
-            from system.lib.features.sc.decode import sc_decode
+            from system.lib.features.sc.assembly_encode import (
+                collect_objects_and_encode,
+            )
+            from system.lib.features.sc.decode import (
+                decode_and_render_objects,
+                decode_textures_only,
+            )
             from system.lib.features.sc.encode import sc_encode
-            from system.lib.features.sc.decode_and_cut import decode_and_cut
-            from system.lib.features.sc.assembly_encode import sc1_encode
 
             sc_category = Menu.Category(0, locale.sc_label)
             sc_category.add(
-                Menu.Item(locale.decode_sc, locale.decode_sc_description, sc_decode)
+                Menu.Item(
+                    locale.decode_sc, locale.decode_sc_description, decode_textures_only
+                )
             )
             sc_category.add(
                 Menu.Item(locale.encode_sc, locale.encode_sc_description, sc_encode)
@@ -89,21 +95,21 @@ def refill_menu():
                 Menu.Item(
                     locale.decode_by_parts,
                     locale.decode_by_parts_description,
-                    decode_and_cut,
+                    decode_and_render_objects,
                 )
             )
             sc_category.add(
                 Menu.Item(
                     locale.encode_by_parts,
                     locale.encode_by_parts_description,
-                    sc1_encode,
+                    collect_objects_and_encode,
                 )
             )
             sc_category.add(
                 Menu.Item(
                     locale.overwrite_by_parts,
                     locale.overwrite_by_parts_description,
-                    lambda: sc1_encode(True),
+                    lambda: collect_objects_and_encode(True),
                 )
             )
             menu.add_category(sc_category)

system/lib/__init__.py

@@ -1,36 +1,39 @@
 import os
+from pathlib import Path
 
 from system.lib.console import Console
 from system.lib.swf import SupercellSWF
 from system.localization import locale
 
 
-def cut_sprites(swf: SupercellSWF, export_folder: str):
-    os.makedirs(f"{export_folder}/overwrite", exist_ok=True)
-    os.makedirs(f"{export_folder}/shapes", exist_ok=True)
-    os.makedirs(f"{export_folder}/movie_clips", exist_ok=True)
+def render_objects(swf: SupercellSWF, output_folder: Path):
+    os.makedirs(output_folder / "overwrite", exist_ok=True)
+    os.makedirs(output_folder / "shapes", exist_ok=True)
+    os.makedirs(output_folder / "movie_clips", exist_ok=True)
 
     # TODO: Too slow, fix it
-    movie_clips_skipped = 0
-    movie_clip_count = len(swf.movie_clips)
-    for movie_clip_index in range(movie_clip_count):
-        movie_clip = swf.movie_clips[movie_clip_index]
-
-        rendered_movie_clip = movie_clip.render(swf)
-        if sum(rendered_movie_clip.size) >= 2:
-            clip_name = movie_clip.export_name or movie_clip.id
-            rendered_movie_clip.save(f"{export_folder}/movie_clips/{clip_name}.png")
-        else:
-            # For debug:
-            # logger.warning(f'MovieClip {movie_clip.id} cannot be rendered.')
-            movie_clips_skipped += 1
-
-        Console.progress_bar(
-            "Rendering movie clips (%d/%d). Skipped count: %d"
-            % (movie_clip_index + 1, movie_clip_count, movie_clips_skipped),
-            movie_clip_index,
-            movie_clip_count,
-        )
+    # movie_clips_skipped = 0
+    # movie_clip_count = len(swf.movie_clips)
+    # for movie_clip_index in range(movie_clip_count):
+    #     movie_clip = swf.movie_clips[movie_clip_index]
+    #
+    #     rendered_movie_clip = movie_clip.render(swf)
+    #     if sum(rendered_movie_clip.size) >= 2:
+    #         clip_name = movie_clip.export_name or movie_clip.id
+    #         rendered_movie_clip.save(f"{export_folder}/movie_clips/{clip_name}.png")
+    #     else:
+    #         # For debug:
+    #         # logger.warning(f'MovieClip {movie_clip.id} cannot be rendered.')
+    #         movie_clips_skipped += 1
+    #
+    #     Console.progress_bar(
+    #         "Rendering movie clips (%d/%d). Skipped count: %d"
+    #         % (movie_clip_index + 1, movie_clip_count, movie_clips_skipped),
+    #         movie_clip_index,
+    #         movie_clip_count,
+    #     )
+
+    print()
 
     shapes_count = len(swf.shapes)
     swf.xcod_writer.write_uint16(shapes_count)
@@ -45,14 +48,14 @@ def cut_sprites(swf: SupercellSWF, export_folder: str):
         )
 
         rendered_shape = shape.render()
-        rendered_shape.save(f"{export_folder}/shapes/{shape.id}.png")
+        rendered_shape.save(f"{output_folder}/shapes/{shape.id}.png")
 
         regions_count = len(shape.regions)
         for region_index in range(regions_count):
             region = shape.regions[region_index]
 
             rendered_region = region.render(use_original_size=True)
-            rendered_region.save(f"{export_folder}/shape_{shape.id}_{region_index}.png")
+            rendered_region.save(f"{output_folder}/shape_{shape.id}_{region_index}.png")
 
     for shape_index in range(shapes_count):
         shape = swf.shapes[shape_index]

system/lib/features/cut_sprites.py

@@ -1,7 +1,5 @@
-import struct
-
 from loguru import logger
-from sc_compression import decompress, compress
+from sc_compression import compress, decompress
 from sc_compression.signatures import Signatures
 
 from system.localization import locale
@@ -13,7 +11,8 @@ def write_sc(output_filename: str, buffer: bytes, use_lzham: bool):
 
         if use_lzham:
             logger.info(locale.compressing_with % "LZHAM")
-            file_out.write(struct.pack("<4sBI", b"SCLZ", 18, len(buffer)))
+            # Why is this here? It's included in the compression module
+            # file_out.write(struct.pack("<4sBI", b"SCLZ", 18, len(buffer)))
             compressed = compress(buffer, Signatures.SCLZ)
 
             file_out.write(compressed)
@@ -24,11 +23,9 @@ def write_sc(output_filename: str, buffer: bytes, use_lzham: bool):
         logger.info(locale.compression_done)
 
 
-def open_sc(input_filename: str):
-    decompressed_data = None
+def open_sc(input_filename: str) -> tuple[bytes, bool]:
     use_lzham = False
 
-    logger.info(locale.collecting_inf)
     with open(input_filename, "rb") as f:
         file_data = f.read()
         f.close()
@@ -37,9 +34,10 @@ def open_sc(input_filename: str):
         if b"START" in file_data:
             file_data = file_data[: file_data.index(b"START")]
         decompressed_data, signature = decompress(file_data)
-        #
-        # logger.info(locale.detected_comp % signature.upper())
-        #
+
+        if signature.name != Signatures.NONE:
+            logger.info(locale.detected_comp % signature.name.upper())
+
         if signature == Signatures.SCLZ:
             use_lzham = True
     except TypeError:

system/lib/features/files.py

@@ -31,15 +31,11 @@ def compile_sc(
             return logger.info(locale.dir_empty % _dir.split("/")[-2])
         files = [Image.open(f"{_dir}{i}") for i in files]
 
-    logger.info(locale.collecting_inf)
     sc = Writer()
 
-    use_lzham = file_info.use_lzham
-
     for picture_index in range(len(files)):
         sheet_info = file_info.sheets[picture_index]
         img = files[picture_index]
-        print()
 
         file_type = sheet_info.file_type
         pixel_type = sheet_info.pixel_type
@@ -67,8 +63,8 @@ def compile_sc(
             split_image(img)
 
         save_texture(sc, img, pixel_type)
+        print()
 
     sc.write(bytes(5))
-    print()
 
-    write_sc(f"{output_folder}/{name}.sc", sc.getvalue(), use_lzham)
+    write_sc(f"{output_folder}/{name}.sc", sc.getvalue(), file_info.use_lzham)

system/lib/features/sc/__init__.py

@@ -7,7 +7,7 @@
 from system.localization import locale
 
 
-def sc1_encode(overwrite: bool = False):
+def collect_objects_and_encode(overwrite: bool = False):
     folder = "./SC/In-Sprites/"
     output_folder = "./SC/Out-Compressed/"
     files = os.listdir(folder)
@@ -18,11 +18,10 @@ def sc1_encode(overwrite: bool = False):
             logger.error(locale.not_found % xcod)
         else:
             try:
-                logger.info(locale.dec_sc)
+                logger.info(locale.collecting_inf % file)
                 sheets, file_info = place_sprites(
                     f"{folder}{file}/{xcod}", f"{folder}{file}", overwrite
                 )
-                logger.info(locale.dec_sc)
                 compile_sc(f"{folder}{file}/", file_info, sheets, output_folder)
             except Exception as exception:
                 logger.exception(