sticker-convert 2.8.1__tar.gz → 2.8.3__tar.gz

{sticker-convert-2.8.1/src/sticker_convert.egg-info → sticker-convert-2.8.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sticker-convert
-Version: 2.8.1
+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>
@@ -483,23 +483,24 @@ usage: sticker-convert.py [-h] [--version] [--no-confirm] [--custom-presets CUST
                           [--preset {auto,signal,telegram,telegram_emoji,whatsapp,line,kakao,imessage_small,imessage_medium,imessage_large,custom}]
                           [--steps STEPS] [--processes PROCESSES] [--fps-min FPS_MIN] [--fps-max FPS_MAX]
                           [--fps-power FPS_POWER] [--res-min RES_MIN] [--res-max RES_MAX] [--res-w-min RES_W_MIN]
-                          [--res-w-max RES_W_MAX] [--res-h-min RES_H_MIN] [--res-h-max RES_H_MAX] [--res-power RES_POWER]
-                          [--quality-min QUALITY_MIN] [--quality-max QUALITY_MAX] [--quality-power QUALITY_POWER]
-                          [--color-min COLOR_MIN] [--color-max COLOR_MAX] [--color-power COLOR_POWER]
-                          [--duration-min DURATION_MIN] [--duration-max DURATION_MAX] [--bg-color BG_COLOR]
-                          [--vid-size-max VID_SIZE_MAX] [--img-size-max IMG_SIZE_MAX] [--vid-format VID_FORMAT]
-                          [--img-format IMG_FORMAT] [--fake-vid] [--scale-filter SCALE_FILTER]
-                          [--quantize-method QUANTIZE_METHOD] [--cache-dir CACHE_DIR] [--default-emoji DEFAULT_EMOJI]
-                          [--signal-uuid SIGNAL_UUID] [--signal-password SIGNAL_PASSWORD] [--signal-get-auth]
-                          [--signal-data-dir SIGNAL_DATA_DIR] [--telegram-token TELEGRAM_TOKEN]
-                          [--telegram-userid TELEGRAM_USERID] [--kakao-auth-token KAKAO_AUTH_TOKEN] [--kakao-get-auth]
-                          [--kakao-username KAKAO_USERNAME] [--kakao-password KAKAO_PASSWORD]
-                          [--kakao-country-code KAKAO_COUNTRY_CODE] [--kakao-phone-number KAKAO_PHONE_NUMBER] [--line-get-auth]
-                          [--line-cookies LINE_COOKIES] [--save-cred SAVE_CRED]
+                          [--res-w-max RES_W_MAX] [--res-h-min RES_H_MIN] [--res-h-max RES_H_MAX]
+                          [--res-power RES_POWER] [--quality-min QUALITY_MIN] [--quality-max QUALITY_MAX]
+                          [--quality-power QUALITY_POWER] [--color-min COLOR_MIN] [--color-max COLOR_MAX]
+                          [--color-power COLOR_POWER] [--duration-min DURATION_MIN] [--duration-max DURATION_MAX]
+                          [--padding-percent PADDING_PERCENT] [--bg-color BG_COLOR] [--vid-size-max VID_SIZE_MAX]
+                          [--img-size-max IMG_SIZE_MAX] [--vid-format VID_FORMAT] [--img-format IMG_FORMAT]
+                          [--fake-vid] [--scale-filter SCALE_FILTER] [--quantize-method QUANTIZE_METHOD]
+                          [--cache-dir CACHE_DIR] [--default-emoji DEFAULT_EMOJI] [--signal-uuid SIGNAL_UUID]
+                          [--signal-password SIGNAL_PASSWORD] [--signal-get-auth] [--signal-data-dir SIGNAL_DATA_DIR]
+                          [--telegram-token TELEGRAM_TOKEN] [--telegram-userid TELEGRAM_USERID]
+                          [--kakao-auth-token KAKAO_AUTH_TOKEN] [--kakao-get-auth] [--kakao-username KAKAO_USERNAME]
+                          [--kakao-password KAKAO_PASSWORD] [--kakao-country-code KAKAO_COUNTRY_CODE]
+                          [--kakao-phone-number KAKAO_PHONE_NUMBER] [--line-get-auth] [--line-cookies LINE_COOKIES]
+                          [--save-cred SAVE_CRED]
 
 CLI for stickers-convert
 
-optional arguments:
+options:
   -h, --help            show this help message and exit
   --version             show program's version number and exit
   --no-confirm          Do not ask any questions.
@@ -585,6 +586,8 @@ Compression options:
                         Set minimum output duration in miliseconds.
   --duration-max DURATION_MAX
                         Set maximum output duration in miliseconds.
+  --padding-percent PADDING_PERCENT
+                        Set percentage of space used as padding.
   --bg-color BG_COLOR   Set custom background color.
                         Example: 00ff00 for green.
                         If this is not set, background color would be auto set to black if image is bright, or white if image is dark.

{sticker-convert-2.8.1 → sticker-convert-2.8.3}/README.md

@@ -96,23 +96,24 @@ usage: sticker-convert.py [-h] [--version] [--no-confirm] [--custom-presets CUST
                           [--preset {auto,signal,telegram,telegram_emoji,whatsapp,line,kakao,imessage_small,imessage_medium,imessage_large,custom}]
                           [--steps STEPS] [--processes PROCESSES] [--fps-min FPS_MIN] [--fps-max FPS_MAX]
                           [--fps-power FPS_POWER] [--res-min RES_MIN] [--res-max RES_MAX] [--res-w-min RES_W_MIN]
-                          [--res-w-max RES_W_MAX] [--res-h-min RES_H_MIN] [--res-h-max RES_H_MAX] [--res-power RES_POWER]
-                          [--quality-min QUALITY_MIN] [--quality-max QUALITY_MAX] [--quality-power QUALITY_POWER]
-                          [--color-min COLOR_MIN] [--color-max COLOR_MAX] [--color-power COLOR_POWER]
-                          [--duration-min DURATION_MIN] [--duration-max DURATION_MAX] [--bg-color BG_COLOR]
-                          [--vid-size-max VID_SIZE_MAX] [--img-size-max IMG_SIZE_MAX] [--vid-format VID_FORMAT]
-                          [--img-format IMG_FORMAT] [--fake-vid] [--scale-filter SCALE_FILTER]
-                          [--quantize-method QUANTIZE_METHOD] [--cache-dir CACHE_DIR] [--default-emoji DEFAULT_EMOJI]
-                          [--signal-uuid SIGNAL_UUID] [--signal-password SIGNAL_PASSWORD] [--signal-get-auth]
-                          [--signal-data-dir SIGNAL_DATA_DIR] [--telegram-token TELEGRAM_TOKEN]
-                          [--telegram-userid TELEGRAM_USERID] [--kakao-auth-token KAKAO_AUTH_TOKEN] [--kakao-get-auth]
-                          [--kakao-username KAKAO_USERNAME] [--kakao-password KAKAO_PASSWORD]
-                          [--kakao-country-code KAKAO_COUNTRY_CODE] [--kakao-phone-number KAKAO_PHONE_NUMBER] [--line-get-auth]
-                          [--line-cookies LINE_COOKIES] [--save-cred SAVE_CRED]
+                          [--res-w-max RES_W_MAX] [--res-h-min RES_H_MIN] [--res-h-max RES_H_MAX]
+                          [--res-power RES_POWER] [--quality-min QUALITY_MIN] [--quality-max QUALITY_MAX]
+                          [--quality-power QUALITY_POWER] [--color-min COLOR_MIN] [--color-max COLOR_MAX]
+                          [--color-power COLOR_POWER] [--duration-min DURATION_MIN] [--duration-max DURATION_MAX]
+                          [--padding-percent PADDING_PERCENT] [--bg-color BG_COLOR] [--vid-size-max VID_SIZE_MAX]
+                          [--img-size-max IMG_SIZE_MAX] [--vid-format VID_FORMAT] [--img-format IMG_FORMAT]
+                          [--fake-vid] [--scale-filter SCALE_FILTER] [--quantize-method QUANTIZE_METHOD]
+                          [--cache-dir CACHE_DIR] [--default-emoji DEFAULT_EMOJI] [--signal-uuid SIGNAL_UUID]
+                          [--signal-password SIGNAL_PASSWORD] [--signal-get-auth] [--signal-data-dir SIGNAL_DATA_DIR]
+                          [--telegram-token TELEGRAM_TOKEN] [--telegram-userid TELEGRAM_USERID]
+                          [--kakao-auth-token KAKAO_AUTH_TOKEN] [--kakao-get-auth] [--kakao-username KAKAO_USERNAME]
+                          [--kakao-password KAKAO_PASSWORD] [--kakao-country-code KAKAO_COUNTRY_CODE]
+                          [--kakao-phone-number KAKAO_PHONE_NUMBER] [--line-get-auth] [--line-cookies LINE_COOKIES]
+                          [--save-cred SAVE_CRED]
 
 CLI for stickers-convert
 
-optional arguments:
+options:
   -h, --help            show this help message and exit
   --version             show program's version number and exit
   --no-confirm          Do not ask any questions.
@@ -198,6 +199,8 @@ Compression options:
                         Set minimum output duration in miliseconds.
   --duration-max DURATION_MAX
                         Set maximum output duration in miliseconds.
+  --padding-percent PADDING_PERCENT
+                        Set percentage of space used as padding.
   --bg-color BG_COLOR   Set custom background color.
                         Example: 00ff00 for green.
                         If this is not set, background color would be auto set to black if image is bright, or white if image is dark.

{sticker-convert-2.8.1 → sticker-convert-2.8.3}/src/sticker_convert/cli.py

@@ -119,6 +119,7 @@ class CLI:
             "duration_max",
             "vid_size_max",
             "img_size_max",
+            "padding_percent",
         )
         flags_comp_float = ("fps_power", "res_power", "quality_power", "color_power")
         flags_comp_str = (
@@ -372,6 +373,9 @@ class CLI:
             bg_color=self.compression_presets[preset]["bg_color"]
             if args.bg_color is None
             else args.bg_color,
+            padding_percent=self.compression_presets[preset]["padding_percent"]
+            if args.padding_percent is None
+            else args.padding_percent,
             steps=self.compression_presets[preset]["steps"]
             if args.steps is None
             else args.steps,

{sticker-convert-2.8.1 → sticker-convert-2.8.3}/src/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
             )
@@ -597,12 +615,13 @@ class StickerConvert:
             if self.res_h is None:
                 self.res_h = height
 
+            scaling = 1 - (self.opt_comp.padding_percent / 100)
             if width > height:
-                width_new = self.res_w
-                height_new = height * self.res_w // width
+                width_new = int(self.res_w * scaling)
+                height_new = int(height * self.res_w // width * scaling)
             else:
-                height_new = self.res_h
-                width_new = width * self.res_h // height
+                height_new = int(self.res_h * scaling)
+                width_new = int(width * self.res_h // height * scaling)
 
             with im.resize((width_new, height_new), resample=resample) as im_resized:
                 with Image.new(
@@ -677,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
@@ -709,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"
@@ -733,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
@@ -744,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
@@ -772,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
@@ -785,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-2.8.1 → sticker-convert-2.8.3}/src/sticker_convert/downloaders/download_telegram.py

@@ -42,7 +42,7 @@ class DownloadTelegram(DownloadBase):
         application = (  # type: ignore
             ApplicationBuilder()
             .token(self.token)
-            .rate_limiter(AIORateLimiter())
+            .rate_limiter(AIORateLimiter(max_retries=3))
             .connect_timeout(timeout)
             .pool_timeout(timeout)
             .read_timeout(timeout)

{sticker-convert-2.8.1 → sticker-convert-2.8.3}/src/sticker_convert/gui.py

@@ -125,6 +125,7 @@ class GUI(Window):
         self.duration_min_var = IntVar(self)
         self.duration_max_var = IntVar(self)
         self.duration_disable_var = BooleanVar()
+        self.padding_percent_var = IntVar(self)
         self.img_size_max_var = IntVar(self)
         self.vid_size_max_var = IntVar(self)
         self.size_disable_var = BooleanVar()
@@ -519,6 +520,7 @@ class GUI(Window):
             if not self.duration_disable_var.get()
             else None,
             bg_color=self.bg_color_var.get(),
+            padding_percent=self.padding_percent_var.get(),
             steps=self.steps_var.get(),
             fake_vid=self.fake_vid_var.get(),
             scale_filter=self.scale_filter_var.get(),
@@ -642,10 +644,10 @@ class GUI(Window):
 
     def cb_bar(
         self,
-        *args: Any,
         set_progress_mode: Optional[str] = None,
         steps: int = 0,
         update_bar: int = 0,
+        *args: Any,
         **kwargs: Any,
     ) -> None:
         self.progress_frame.update_progress_bar(