sticker-convert 2.8.2__py3-none-any.whl → 2.8.3__py3-none-any.whl

sticker_convert/converter.py

@@ -9,6 +9,7 @@ from typing import TYPE_CHECKING, Any, Dict, List, Literal, Optional, Tuple, Uni
 import numpy as np
 from PIL import Image
 from PIL import __version__ as PillowVersion
+from PIL import features
 
 from sticker_convert.job_option import CompOption
 from sticker_convert.utils.callback import CallbackProtocol, CallbackReturn
@@ -32,6 +33,17 @@ MSG_FAIL_COMP = (
     "[F] Failed Compression {} -> {}, "
     "cannot get below limit {} with lowest quality under current settings (Best size: {})"
 )
+MSG_PYWEBP_DUPFRAME = (
+    "[W] {} contains duplicated frame.\n"
+    "    System WebP>=0.5.0 was not found, hence Pillow cannot be used\n"
+    "    for creating animated webp. Using pywebp instead, which is known to\n"
+    "    collapse same frames into single frame, causing problem with animation timing."
+)
+MSG_WEBP_PIL_DUPFRAME = (
+    "[W] {} contains duplicated frame.\n"
+    "    Using Pillow to create animated webp to avoid same frames collapse\n"
+    "    into single frame, but this is slower."
+)
 
 YUV_RGB_MATRIX = np.array(
     [
@@ -41,6 +53,10 @@ YUV_RGB_MATRIX = np.array(
     ]
 )
 
+# Whether animated WebP is supported
+# See https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html#saving-sequences
+PIL_WEBP_ANIM = cast(bool, features.check("webp_anim"))  # type: ignore
+
 
 def get_step_value(
     max_step: Optional[int],
@@ -179,6 +195,8 @@ class StickerConvert:
         self.result_step: Optional[int] = None
 
         self.apngasm = None
+        self.msg_pywebp_dupframe_displayed = False
+        self.msg_webp_pil_dupframe_displayed = False
 
     @staticmethod
     def convert(
@@ -394,7 +412,7 @@ class StickerConvert:
             with open(self.out_f, "wb+") as f:
                 f.write(data)
 
-        if result_step:
+        if result_step is not None:
             msg = MSG_DONE_COMP.format(
                 self.in_f_name, self.out_f_name, self.result_size, result_step
             )
@@ -678,14 +696,51 @@ class StickerConvert:
                 self._frames_export_apng()
             else:
                 self._frames_export_png()
-        elif self.out_f.suffix == ".webp" and is_animated:
+        elif self.out_f.suffix == ".webp":
             self._frames_export_webp()
         elif self.out_f.suffix == ".gif":
-            self._frames_export_gif()
+            self._frames_export_pil_anim()
         elif self.out_f.suffix in (".webm", ".mp4", ".mkv") or is_animated:
             self._frames_export_pyav()
         else:
             self._frames_export_pil()
+    
+    def _check_dup(self) -> bool:
+        if len(self.frames_processed) == 1:
+            return False
+
+        prev_frame = self.frames_processed[0]
+        for frame in self.frames_processed[1:]:
+            if np.array_equal(frame, prev_frame):
+                return True
+            prev_frame = frame
+
+        return False
+
+    def _frames_export_webp(self) -> None:
+        has_dup_frames = self._check_dup()
+        if self.fps:
+            # It was noted that pywebp would collapse all frames.
+            # aed005b attempted to fix this by creating webp with
+            # variable frame duration. However, the webp created would
+            # not be accepted by WhatsApp.
+            # Therefore, we are preferring Pillow over pywebp.
+            if has_dup_frames:
+                if PIL_WEBP_ANIM:
+                    # Warn that using Pillow is slower
+                    if not self.msg_webp_pil_dupframe_displayed:
+                        self.cb.put(MSG_WEBP_PIL_DUPFRAME.format(self.in_f_name))
+                        self.msg_webp_pil_dupframe_displayed = True
+                    self._frames_export_pil_anim()
+                else:
+                    if not self.msg_pywebp_dupframe_displayed:
+                        self.cb.put(MSG_PYWEBP_DUPFRAME.format(self.in_f_name))
+                        self.msg_pywebp_dupframe_displayed = True
+                    self._frames_export_pywebp()
+            else:
+                self._frames_export_pywebp()
+        else:
+            self._frames_export_pil()
 
     def _frames_export_pil(self) -> None:
         with Image.fromarray(self.frames_processed[0]) as im:  # type: ignore
@@ -710,7 +765,7 @@ class StickerConvert:
             codec = "apng"
             pixel_format = "rgba"
             options["plays"] = "0"
-        elif self.out_f.suffix in (".webp", ".webm", ".mkv"):
+        elif self.out_f.suffix in (".webm", ".mkv"):
             codec = "libvpx-vp9"
             pixel_format = "yuva420p"
             options["loop"] = "0"
@@ -734,7 +789,7 @@ class StickerConvert:
                 output.mux(out_stream.encode(av_frame))
             output.mux(out_stream.encode())
 
-    def _frames_export_gif(self) -> None:
+    def _frames_export_pil_anim(self) -> None:
         extra_kwargs: Dict[str, Any] = {}
 
         # disposal=2 on gif cause flicker in image with transparency
@@ -745,25 +800,34 @@ class StickerConvert:
         else:
             extra_kwargs["optimize"] = True
 
-        # GIF can only have one alpha color
-        # Change lowest alpha to alpha=0
-        # Only keep alpha=0 and alpha=255, nothing in between
-        frames_processed = np.array(self.frames_processed)
-        alpha = frames_processed[:, :, :, 3]
-        alpha_min = np.min(alpha)  # type: ignore
-        if alpha_min < 255:
-            alpha[alpha > alpha_min] = 255
-            alpha[alpha == alpha_min] = 0
-
-        if 0 in alpha:
-            extra_kwargs["transparency"] = 0
-            extra_kwargs["disposal"] = 2
-            im_out = [self.quantize(Image.fromarray(i)) for i in frames_processed]  # type: ignore
+        if self.out_f.suffix == ".gif":
+            # GIF can only have one alpha color
+            # Change lowest alpha to alpha=0
+            # Only keep alpha=0 and alpha=255, nothing in between
+            frames_processed = np.array(self.frames_processed)
+            alpha = frames_processed[:, :, :, 3]
+            alpha_min = np.min(alpha)  # type: ignore
+            if alpha_min < 255:
+                alpha[alpha > alpha_min] = 255
+                alpha[alpha == alpha_min] = 0
+
+            if 0 in alpha:
+                extra_kwargs["transparency"] = 0
+                extra_kwargs["disposal"] = 2
+                im_out = [self.quantize(Image.fromarray(i)) for i in frames_processed]  # type: ignore
+            else:
+                im_out = [
+                    self.quantize(Image.fromarray(i).convert("RGB")).convert("RGB")  # type: ignore
+                    for i in frames_processed
+                ]
+                extra_kwargs["format"] = "GIF"
+        elif self.out_f.suffix == ".webp":
+            im_out = [Image.fromarray(i) for i in self.frames_processed]  # type: ignore
+            extra_kwargs["format"] = "WebP"
+            extra_kwargs["minimize_size"] = True
+            extra_kwargs["method"] = 6
         else:
-            im_out = [
-                self.quantize(Image.fromarray(i).convert("RGB")).convert("RGB")  # type: ignore
-                for i in frames_processed
-            ]
+            raise RuntimeError(f"Invalid format {self.out_f.suffix}")
 
         if self.fps:
             extra_kwargs["save_all"] = True
@@ -773,12 +837,11 @@ class StickerConvert:
 
         im_out[0].save(
             self.tmp_f,
-            format="GIF",
             quality=self.quality,
             **extra_kwargs,
         )
 
-    def _frames_export_webp(self) -> None:
+    def _frames_export_pywebp(self) -> None:
         import webp  # type: ignore
 
         assert self.fps
@@ -786,25 +849,10 @@ class StickerConvert:
         config = webp.WebPConfig.new(quality=self.quality)  # type: ignore
         enc = webp.WebPAnimEncoder.new(self.res_w, self.res_h)  # type: ignore
         timestamp_ms = 0
-        timestamp_inc = int(1000 / self.fps)
-
-        pic = webp.WebPPicture.from_numpy(self.frames_processed[0])  # type: ignore
-        enc.encode_frame(pic, 0, config=config)  # type: ignore
-
-        frame_num = 1
-        frame_num_prev = 1
-        frame_total = len(self.frames_processed)
-        while frame_num < frame_total - 1:
-            while frame_num < frame_total - 1 and np.array_equal(
-                self.frames_processed[frame_num_prev],
-                self.frames_processed[frame_num],
-            ):
-                timestamp_ms += timestamp_inc
-                frame_num += 1
-            pic = webp.WebPPicture.from_numpy(self.frames_processed[frame_num])  # type: ignore
+        for frame in self.frames_processed:
+            pic = webp.WebPPicture.from_numpy(frame)  # type: ignore
             enc.encode_frame(pic, timestamp_ms, config=config)  # type: ignore
-            frame_num_prev = frame_num
-
+            timestamp_ms += int(1000 / self.fps)
         anim_data = enc.assemble(timestamp_ms)  # type: ignore
         self.tmp_f.write(anim_data.buffer())  # type: ignore
 

sticker_convert/uploaders/compress_wastickers.py

@@ -79,7 +79,7 @@ class CompressWastickers(UploadBase):
                     else:
                         ext = ".png"
 
-                    dst = Path(tempdir, str(num) + ext)
+                    dst = Path(tempdir, f"sticker_{num+1}{ext}")
 
                     if FormatVerify.check_file(
                         src, spec=self.webp_spec
@@ -114,7 +114,7 @@ class CompressWastickers(UploadBase):
         opt_comp_merged.merge(self.spec_cover)
 
         cover_path_old = MetadataHandler.get_cover(self.opt_output.dir)
-        cover_path_new = Path(pack_dir, "100.png")
+        cover_path_new = Path(pack_dir, "tray.png")
         if cover_path_old:
             if FormatVerify.check_file(cover_path_old, spec=self.spec_cover):
                 shutil.copy(cover_path_old, cover_path_new)
@@ -142,7 +142,7 @@ class CompressWastickers(UploadBase):
                 self.cb_return,
             )
 
-        MetadataHandler.set_metadata(pack_dir, author=author, title=title)
+        MetadataHandler.set_metadata(pack_dir, author=author, title=title, newline=True)
 
     @staticmethod
     def start(

sticker_convert/utils/files/metadata_handler.py

@@ -133,16 +133,21 @@ class MetadataHandler:
         title: Optional[str] = None,
         author: Optional[str] = None,
         emoji_dict: Optional[Dict[str, str]] = None,
+        newline: bool = False,
     ) -> None:
         title_path = Path(directory, "title.txt")
         if title is not None:
             with open(title_path, "w+", encoding="utf-8") as f:
                 f.write(title)
+                if newline:
+                    f.write("\n")
 
         author_path = Path(directory, "author.txt")
         if author is not None:
             with open(author_path, "w+", encoding="utf-8") as f:
                 f.write(author)
+                if newline:
+                    f.write("\n")
 
         emoji_path = Path(directory, "emoji.txt")
         if emoji_dict is not None:

sticker_convert/version.py

@@ -1,3 +1,3 @@
 #!/usr/bin/env python3
 
-__version__ = "2.8.2"
+__version__ = "2.8.3"

{sticker_convert-2.8.2.dist-info → sticker_convert-2.8.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sticker-convert
-Version: 2.8.2
+Version: 2.8.3
 Summary: Convert (animated) stickers to/from WhatsApp, Telegram, Signal, Line, Kakao, iMessage. Written in Python.
 Author-email: laggykiller <chaudominic2@gmail.com>
 Maintainer-email: laggykiller <chaudominic2@gmail.com>

{sticker_convert-2.8.2.dist-info → sticker_convert-2.8.3.dist-info}/RECORD

@@ -1,12 +1,12 @@
 sticker_convert/__init__.py,sha256=iQnv6UOOA69c3soAn7ZOnAIubTIQSUxtq1Uhh8xRWvU,102
 sticker_convert/__main__.py,sha256=6RJauR-SCSSTT3TU7FFB6B6PVwsCxO2xZXtmZ3jc2Is,463
 sticker_convert/cli.py,sha256=KMl8G25rTpSko46SC-WdI5YDBykyluQL13PYpZW_O8M,18579
-sticker_convert/converter.py,sha256=tGUTcMLVvfq5BFqIev76jzDiONe0KNKC-e-cHpawuP0,35074
+sticker_convert/converter.py,sha256=CwhOuH8Os5zU_cLKmK0IKLAurA_-9-4E0cccQNHLp8Y,37357
 sticker_convert/definitions.py,sha256=ZhP2ALCEud-w9ZZD4c3TDG9eHGPZyaAL7zPUsJAbjtE,2073
 sticker_convert/gui.py,sha256=TRPGwMhSMPHnZppHmw2OWHKTJtGoeLpGWD0eRYi4_yk,30707
 sticker_convert/job.py,sha256=dBo98c5dIbg5ZUY8CEE1XQOSoBuf5VOZc-8pmq0Y1Js,25608
 sticker_convert/job_option.py,sha256=JHAFCxp7-dDwD-1PbpYLAFRF3OoJu8cj_BjOm5r8Gp8,7732
-sticker_convert/version.py,sha256=cG0zSLjJ4KXuLjUEWES88zpDwr28nDF8AaBVALGm5Ec,46
+sticker_convert/version.py,sha256=s6EC7_A6bcTAEEXvg8UKbvmODYWmAfNLeSy3bqzdqAY,46
 sticker_convert/downloaders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sticker_convert/downloaders/download_base.py,sha256=CcrgZiBOYJbYcDGCPDHp-ECGXSpfmGtQCzS7KRbBl1E,2726
 sticker_convert/downloaders/download_kakao.py,sha256=UFp7EpMea62fIePY5DfhH4jThAwdeazfoC5iW1g4dAo,8516
@@ -72,7 +72,7 @@ sticker_convert/resources/help.json,sha256=7VKc4Oxw6e4zv2IIeYRQ5e_aa88UlsgIHSBm9
 sticker_convert/resources/input.json,sha256=sRz8qWaLh2KTjjlPIxz2UfynVn2Bn0olywbb8-qT_Hc,2251
 sticker_convert/resources/output.json,sha256=QYP2gqDvEaAm5I9bH4NReaB1XMLboevv69u-V8YdZUs,1373
 sticker_convert/uploaders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sticker_convert/uploaders/compress_wastickers.py,sha256=xNua2pDPD-7Q2Fx9WLo1IlncVs3jVPMN-pxXTswjk8g,5997
+sticker_convert/uploaders/compress_wastickers.py,sha256=SMPf1_ir30ZKO2ChHspDFuyaufx0XeVBVLOlHmawEdY,6021
 sticker_convert/uploaders/upload_base.py,sha256=uQupPn6r4zrlAzpKzzX7CgvZb69ATyrwPKahWOQj0ds,1203
 sticker_convert/uploaders/upload_signal.py,sha256=vFMvQ4TwDNliPuQ7ecXHzTT-qrTwPAORbSxZ7Nk9VM4,6541
 sticker_convert/uploaders/upload_telegram.py,sha256=KXQskywHjiVWLDz6qjzJhZk14PNRD3vQ-HNORNa1vNI,14634
@@ -85,16 +85,16 @@ sticker_convert/utils/auth/get_signal_auth.py,sha256=6Sx-lMuyBHeX1RpjAWI8u03qnRu
 sticker_convert/utils/files/cache_store.py,sha256=etfe614OAhAyrnM5fGeESKq6R88YLNqkqkxSzEmZ0V0,1047
 sticker_convert/utils/files/json_manager.py,sha256=Vr6pZJdLMkrJJWN99210aduVHb0ILyf0SSTaw4TZqgc,541
 sticker_convert/utils/files/json_resources_loader.py,sha256=flZFixUXRTrOAhvRQpuSQgmJ69yXL94sxukcowLT1JQ,1049
-sticker_convert/utils/files/metadata_handler.py,sha256=TJpQ-7KdnqQh09hwR6xB_scRLhbJ6D3zgORy3dkf858,9933
+sticker_convert/utils/files/metadata_handler.py,sha256=5ED1UVoAaObgAXe4NZ8sXfsNX7JQvGIqgfCQCjpXRjc,10088
 sticker_convert/utils/files/run_bin.py,sha256=QalA9je6liHxiOtxsjsFsIkc2t59quhcJCVpP1X3p50,1743
 sticker_convert/utils/files/sanitize_filename.py,sha256=HBklPGsHRJjFQUIC5rYTQsUrsuTtezZXIEA8CPhLP8A,2156
 sticker_convert/utils/media/apple_png_normalize.py,sha256=LbrQhc7LlYX4I9ek4XJsZE4l0MygBA1jB-PFiYLEkzk,3657
 sticker_convert/utils/media/codec_info.py,sha256=SJSFvQzXHnGkj7MH9xJ5xiC4cqiOjFKckFKE_FICdT4,15562
 sticker_convert/utils/media/decrypt_kakao.py,sha256=4wq9ZDRnFkx1WmFZnyEogBofiLGsWQM_X69HlA36578,1947
 sticker_convert/utils/media/format_verify.py,sha256=Xf94jyqk_6M9IlFGMy0wYIgQKn_yg00nD4XW0CgAbew,5732
-sticker_convert-2.8.2.dist-info/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
-sticker_convert-2.8.2.dist-info/METADATA,sha256=rY1d2u1zQbf4IbudJK4UxA1dnWkhdCM9BMNS8mov49k,49284
-sticker_convert-2.8.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-sticker_convert-2.8.2.dist-info/entry_points.txt,sha256=MNJ7XyC--ugxi5jS1nzjDLGnxCyLuaGdsVLnJhDHCqs,66
-sticker_convert-2.8.2.dist-info/top_level.txt,sha256=r9vfnB0l1ZnH5pTH5RvkobnK3Ow9m0RsncaOMAtiAtk,16
-sticker_convert-2.8.2.dist-info/RECORD,,
+sticker_convert-2.8.3.dist-info/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
+sticker_convert-2.8.3.dist-info/METADATA,sha256=1Z_8zjVrd5RMAilj-dAEVVGBtbYzkchvTDgzeWsfCTA,49284
+sticker_convert-2.8.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+sticker_convert-2.8.3.dist-info/entry_points.txt,sha256=MNJ7XyC--ugxi5jS1nzjDLGnxCyLuaGdsVLnJhDHCqs,66
+sticker_convert-2.8.3.dist-info/top_level.txt,sha256=r9vfnB0l1ZnH5pTH5RvkobnK3Ow9m0RsncaOMAtiAtk,16
+sticker_convert-2.8.3.dist-info/RECORD,,