sticker-convert 2.11.9__tar.gz → 2.12.1__tar.gz

{sticker_convert-2.11.9/src/sticker_convert.egg-info → sticker_convert-2.12.1}/PKG-INFO

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

{sticker_convert-2.11.9 → sticker_convert-2.12.1}/src/sticker_convert/converter.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+import json
 import os
 from fractions import Fraction
 from io import BytesIO
@@ -7,12 +8,14 @@ from pathlib import Path
 from typing import TYPE_CHECKING, Any, Dict, List, Literal, Optional, Tuple, Union, cast
 
 import numpy as np
+from bs4 import BeautifulSoup
 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
+from sticker_convert.utils.chrome_remotedebug import CRD
 from sticker_convert.utils.files.cache_store import CacheStore
 from sticker_convert.utils.media.codec_info import CodecInfo, rounding
 from sticker_convert.utils.media.format_verify import FormatVerify
@@ -423,9 +426,78 @@ class StickerConvert:
             # ffmpeg do not support webp decoding (yet)
             # ffmpeg could fail to decode apng if file is buggy
             self._frames_import_pillow()
+        elif suffix == ".svg":
+            self._frames_import_svg()
         else:
             self._frames_import_pyav()
 
+    def _frames_import_svg(self) -> None:
+        width = self.codec_info_orig.res[0]
+        height = self.codec_info_orig.res[1]
+
+        chrome_path = CRD.get_chrome_path()
+        args = [
+            "--headless",
+            "--disable-extensions",
+            "--disable-infobars",
+            "--disable-gpu",
+            "--disable-gpu-rasterization",
+            "--hide-scrollbars",
+            f"--window-size={width + 100},{height + 100}",
+            "about:blank",
+        ]
+        if chrome_path is None:
+            raise RuntimeError("[F] Chrome/Chromium required for importing svg")
+        self.cb.put("[W] Importing SVG takes long time")
+
+        if isinstance(self.in_f, bytes):
+            svg = self.in_f.decode()
+        else:
+            with open(self.in_f) as f:
+                svg = f.read()
+        soup = BeautifulSoup(svg, "html.parser")
+        svg_tag = soup.find_all("svg")[0]
+
+        if svg_tag.get("width") is None:
+            svg_tag["width"] = width
+        if svg_tag.get("height") is None:
+            svg_tag["height"] = height
+        svg = str(soup)
+
+        crd = None
+        try:
+            crd = CRD(chrome_path, args=args)
+            crd.connect(-1)
+            crd.open_html_str(svg)
+            crd.set_transparent_bg()
+            crd.exec_js('svg = document.getElementsByTagName("svg")[0]')
+            x = json.loads(crd.exec_js("svg.getBoundingClientRect().x"))["result"][
+                "result"
+            ]["value"]
+            y = json.loads(crd.exec_js("svg.getBoundingClientRect().y"))["result"][
+                "result"
+            ]["value"]
+            clip = {"x": x, "y": y, "width": width, "height": height, "scale": 1}
+
+            if self.codec_info_orig.fps > 0:
+                crd.exec_js("svg.pauseAnimations()")
+                for i in range(self.codec_info_orig.frames):
+                    curr_time = (
+                        i
+                        / self.codec_info_orig.frames
+                        * self.codec_info_orig.duration
+                        / 1000
+                    )
+                    crd.exec_js(f"svg.setCurrentTime({curr_time})")
+                    self.frames_raw.append(
+                        np.asarray(crd.screenshot(clip).convert("RGBA"))
+                    )
+            else:
+                self.frames_raw.append(np.asarray(crd.screenshot(clip).convert("RGBA")))
+        finally:
+            if crd is not None:
+                crd.close()
+
     def _frames_import_pillow(self) -> None:
         with Image.open(self.in_f) as im:
             # Note: im.convert("RGBA") would return rgba image of current frame only

{sticker_convert-2.11.9 → sticker_convert-2.12.1}/src/sticker_convert/definitions.py

@@ -82,3 +82,10 @@ def get_config_dir() -> Path:
 
 # Directory for saving configs
 CONFIG_DIR = get_config_dir()
+
+# When importing SVG, import at this fps
+SVG_SAMPLE_FPS = 30
+
+# If width and height not set in SVG tag, import at this dimension
+SVG_DEFAULT_WIDTH = 1024
+SVG_DEFAULT_HEIGHT = 1024

{sticker_convert-2.11.9 → sticker_convert-2.12.1}/src/sticker_convert/downloaders/download_kakao.py

@@ -128,7 +128,9 @@ class DownloadKakao(DownloadBase):
             self.pack_title = urlparse(r.url).path.split("/")[-1]
             pack_info_unauthed = MetadataKakao.get_pack_info_unauthed(self.pack_title)
             if pack_info_unauthed is None:
-                self.cb.put("Download failed: Cannot download metadata for sticker pack")
+                self.cb.put(
+                    "Download failed: Cannot download metadata for sticker pack"
+                )
                 return 0, 0
 
             self.author = pack_info_unauthed["result"]["artist"]
@@ -136,11 +138,15 @@ class DownloadKakao(DownloadBase):
 
             if item_code is None:
                 if self.auth_token is None:
-                    self.cb.put("Warning: Downloading animated sticker requires auth_token")
+                    self.cb.put(
+                        "Warning: Downloading animated sticker requires auth_token"
+                    )
                 else:
-                    self.cb.put("Warning: auth_token invalid, cannot download animated sticker")
+                    self.cb.put(
+                        "Warning: auth_token invalid, cannot download animated sticker"
+                    )
                 self.cb.put("Downloading static stickers...")
-                self.download_static(thumbnail_urls)
+                return self.download_static(thumbnail_urls)
             else:
                 return self.download_animated(item_code)
 

{sticker_convert-2.11.9 → sticker_convert-2.12.1}/src/sticker_convert/downloaders/download_viber.py

@@ -19,7 +19,7 @@ class DownloadViber(DownloadBase):
     # def __init__(self, *args: Any, **kwargs: Any) -> None:
     #     super().__init__(*args, **kwargs)
 
-    def get_pack_info(self, url: str) -> Optional[Tuple[str, str]]:
+    def get_pack_info(self, url: str) -> Optional[Tuple[str, str, str]]:
         r = requests.get(url, allow_redirects=True)
         soup = BeautifulSoup(r.text, "html.parser")
 
@@ -41,10 +41,13 @@ class DownloadViber(DownloadBase):
         title = pack_dict["title"]
         first_sticker_url = cast(str, pack_dict["stickerFirstItemUrl"])
         zip_url = "/".join(first_sticker_url.split("/")[:-1]) + ".zip"
+        pack_id = pack_dict["id"].split(".")[-1]
 
-        return title, zip_url
+        return title, zip_url, pack_id
 
-    def decompress(self, zip_file: bytes) -> int:
+    def decompress(
+        self, zip_file: bytes, exts: Optional[Tuple[str, ...]] = None
+    ) -> int:
         with zipfile.ZipFile(BytesIO(zip_file)) as zf:
             self.cb.put("Unzipping...")
 
@@ -58,9 +61,14 @@ class DownloadViber(DownloadBase):
             )
 
             for sticker in zf_files:
+                ext = Path(sticker).suffix
+                if "frame" in sticker or ".db" in sticker or sticker.endswith("/"):
+                    continue
+                if exts is not None and ext not in exts:
+                    continue
                 num = sticker.split(".")[0][-2:].zfill(3)
                 data = zf.read(sticker)
-                ext = Path(sticker).suffix
+
                 self.cb.put(f"Read {sticker}")
 
                 out_path = Path(self.out_dir, num + ext)
@@ -76,10 +84,16 @@ class DownloadViber(DownloadBase):
         if pack_info is None:
             self.cb.put("Download failed: Cannot get pack info")
             return 0, 0
-        title, zip_url = pack_info
+        title, zip_url, pack_id = pack_info
 
+        anim_url = f"https://content.cdn.viber.com/stickers/ASVG/{pack_id}.zip"
+        anim_file = self.download_file(anim_url)
         zip_file = self.download_file(zip_url)
-        count = self.decompress(zip_file)
+        if anim_file:
+            count = self.decompress(anim_file, (".svg",))
+            count += self.decompress(zip_file, (".mp3",))
+        else:
+            count = self.decompress(zip_file, (".mp3", ".png"))
 
         MetadataHandler.set_metadata(self.out_dir, title=title)
 

{sticker_convert-2.11.9 → sticker_convert-2.12.1}/src/sticker_convert/uploaders/upload_viber.py

@@ -25,13 +25,14 @@ class UploadViber(UploadBase):
         self.png_spec = copy.deepcopy(self.base_spec)
         self.png_spec.set_res_max(490)
         self.png_spec.set_format((".png",))
+        self.opt_comp_merged = copy.deepcopy(self.opt_comp)
+        self.opt_comp_merged.merge(self.png_spec)
 
         self.png_cover_spec = copy.deepcopy(self.base_spec)
         self.png_cover_spec.set_res_max(120)
-        self.png_spec.set_format((".png",))
-
-        self.opt_comp_merged = copy.deepcopy(self.opt_comp)
-        self.opt_comp_merged.merge(self.png_spec)
+        self.png_cover_spec.set_format((".png",))
+        self.opt_comp_cover_merged = copy.deepcopy(self.opt_comp)
+        self.opt_comp_cover_merged.merge(self.png_cover_spec)
 
     def upload_stickers_viber(self) -> Tuple[int, int, List[str]]:
         urls: List[str] = []
@@ -72,23 +73,22 @@ class UploadViber(UploadBase):
             separate_image_anim=False,
         )
 
-        cover_path_old = MetadataHandler.get_cover(self.opt_output.dir)
-        if cover_path_old:
-            cover_path = cover_path_old
+        cover_path = MetadataHandler.get_cover(self.opt_output.dir)
+        if cover_path is None:
+            cover_path = MetadataHandler.get_stickers_present(self.opt_output.dir)[0]
+
+        if FormatVerify.check_file(cover_path, spec=self.png_cover_spec):
+            with open(cover_path, "rb") as f:
+                cover_bytes = f.read()
         else:
-            cover_path_old = MetadataHandler.get_stickers_present(self.opt_output.dir)[
-                0
-            ]
-            cover_path = self.opt_output.dir / "cover.png"
-
-        if not FormatVerify.check_file(cover_path_old, spec=self.png_cover_spec):
-            StickerConvert.convert(
-                cover_path_old,
+            _, _, cover_bytes, _ = StickerConvert.convert(  # type: ignore
                 cover_path,
-                self.opt_comp_merged,
+                Path("bytes.png"),
+                self.opt_comp_cover_merged,
                 self.cb,
                 self.cb_return,
             )
+            assert isinstance(cover_bytes, bytes)
 
         stickers_total = 0
         stickers_ok = 0
@@ -126,12 +126,12 @@ class UploadViber(UploadBase):
             upload_data["description"] = author
             upload_data["shareable"] = "1"
 
-            with open(out_f, "rb") as f, open(cover_path, "rb") as g:
+            with open(out_f, "rb") as f:
                 r = requests.post(
                     "https://market.api.viber.com/2/users/custom-sticker-packs/create",
                     files={
-                        "file": ("upload.zip", f),
-                        "file_icon": ("color_icon.png", g),
+                        "file": ("upload.zip", f.read()),
+                        "file_icon": ("color_icon.png", cover_bytes),
                     },
                     data=upload_data,
                 )

{sticker_convert-2.11.9 → sticker_convert-2.12.1}/src/sticker_convert/utils/chrome_remotedebug.py

@@ -1,4 +1,6 @@
 #!/usr/bin/env python3
+import base64
+import io
 import json
 import os
 import platform
@@ -6,10 +8,11 @@ import shutil
 import socket
 import subprocess
 import time
-from typing import Any, Dict, Optional, Union, cast
+from typing import Any, Dict, List, Optional, Union, cast
 
 import requests
 import websocket
+from PIL import Image
 
 # References
 # https://github.com/yeongbin-jo/python-chromedriver-autoinstaller/blob/master/chromedriver_autoinstaller/utils.py
@@ -24,15 +27,31 @@ def get_free_port() -> int:
 
 
 class CRD:
-    def __init__(self, chrome_bin: str, port: Optional[int] = None):
+    def __init__(
+        self,
+        chrome_bin: str,
+        port: Optional[int] = None,
+        args: Optional[List[str]] = None,
+    ):
         if port is None:
             port = get_free_port()
         self.port = port
-        launch_cmd = [
+
+        launch_cmd: List[str] = []
+        if (
+            platform.system() == "Linux"
+            and os.environ.get("DISPLAY", False) is False
+            and shutil.which("xvfb-run")
+        ):
+            launch_cmd += ["xvfb-run", "--server-args='-screen 0, 1024x768x24'"]
+
+        launch_cmd += [
             chrome_bin,
             f"--remote-debugging-port={port}",
-            f"--remote-allow-origins=http://localhost:{port}",
+            f"--remote-allow-origins=http://127.0.0.1:{port}",
         ]
+        if args:
+            launch_cmd += args
 
         # Adding --no-sandbox in Windows may cause Signal fail to launch
         # https://github.com/laggykiller/sticker-convert/issues/274
@@ -40,7 +59,7 @@ class CRD:
             platform.system() != "Windows"
             and "geteuid" in dir(os)
             and os.geteuid() == 0
-        ):
+        ) or os.path.isfile("/.dockerenv"):
             launch_cmd.append("--no-sandbox")
 
         self.chrome_proc = subprocess.Popen(launch_cmd)
@@ -89,12 +108,17 @@ class CRD:
                     return chrome_bin
             return None
 
-    def connect(self):
+    def connect(self, target_id: int = 0):
         self.cmd_id = 1
         r = None
+        targets: List[Any] = []
         for _ in range(30):
             try:
-                r = requests.get(f"http://localhost:{self.port}/json")
+                r = requests.get(f"http://127.0.0.1:{self.port}/json")
+                targets = json.loads(r.text)
+                if len(targets) == 0:
+                    time.sleep(1)
+                    continue
                 break
             except requests.exceptions.ConnectionError:
                 time.sleep(1)
@@ -102,17 +126,12 @@ class CRD:
         if r is None:
             raise RuntimeError("Cannot connect to chrome debugging port")
 
-        targets = json.loads(r.text)
-        for _ in range(30):
-            if len(targets) == 0:
-                time.sleep(1)
-            else:
-                break
-
         if len(targets) == 0:
             raise RuntimeError("Cannot create websocket connection with debugger")
 
-        self.ws = websocket.create_connection(targets[0]["webSocketDebuggerUrl"])  # type: ignore
+        self.ws = websocket.create_connection(  # type: ignore
+            targets[target_id]["webSocketDebuggerUrl"]
+        )
 
     def send_cmd(self, command: Dict[Any, Any]) -> Union[str, bytes]:
         if command.get("id") is None:
@@ -138,6 +157,27 @@ class CRD:
             command["params"]["contextId"] = context_id
         return self.send_cmd(command)
 
+    def set_transparent_bg(self) -> Union[str, bytes]:
+        command: Dict[str, Any] = {
+            "id": self.cmd_id,
+            "method": "Emulation.setDefaultBackgroundColorOverride",
+            "params": {"color": {"r": 0, "g": 0, "b": 0, "a": 0}},
+        }
+        return self.send_cmd(command)
+
+    def screenshot(self, clip: Optional[Dict[str, int]] = None):
+        command: Dict[str, Any] = {
+            "id": self.cmd_id,
+            "method": "Page.captureScreenshot",
+            "params": {},
+        }
+        if clip:
+            command["params"]["clip"] = clip
+        result = self.send_cmd(command)
+        return Image.open(
+            io.BytesIO(base64.b64decode(json.loads(result)["result"]["data"]))
+        )
+
     def get_curr_url(self) -> str:
         r = self.exec_js("window.location.href")
         return cast(
@@ -148,6 +188,26 @@ class CRD:
         command = {"id": self.cmd_id, "method": "Page.navigate", "params": {"url": url}}
         self.send_cmd(command)
 
+    def open_html_str(self, html: str):
+        command: Dict[str, Any] = {
+            "id": self.cmd_id,
+            "method": "Page.navigate",
+            "params": {"url": "about:blank"},
+        }
+        result = cast(str, self.send_cmd(command))
+        frame_id = json.loads(result).get("result", {}).get("frameId", None)
+        if frame_id is None:
+            raise RuntimeError(f"Cannot navigate to about:blank ({result})")
+
+        self.exec_js('document.getElementsByTagName("html")[0].remove()')
+
+        command = {
+            "id": self.cmd_id,
+            "method": "Page.setDocumentContent",
+            "params": {"frameId": frame_id, "html": html},
+        }
+        self.send_cmd(command)
+
     def runtime_enable(self):
         command = {
             "method": "Runtime.enable",

{sticker_convert-2.11.9 → sticker_convert-2.12.1}/src/sticker_convert/utils/files/metadata_handler.py

@@ -17,6 +17,7 @@ RELATED_EXTENSIONS = (
     ".tgs",
     ".lottie",
     ".json",
+    ".svg",
     ".mp4",
     ".mkv",
     ".mov",

{sticker_convert-2.11.9 → sticker_convert-2.12.1}/src/sticker_convert/utils/media/codec_info.py

@@ -3,16 +3,22 @@ from __future__ import annotations
 
 import json
 import mmap
+import warnings
 from decimal import ROUND_HALF_UP, Decimal
 from fractions import Fraction
 from io import BytesIO
-from math import gcd
+from math import ceil, gcd
 from pathlib import Path
 from typing import BinaryIO, List, Optional, Tuple, Union, cast
 
+from bs4 import BeautifulSoup, XMLParsedAsHTMLWarning
 from PIL import Image, UnidentifiedImageError
 from rlottie_python.rlottie_wrapper import LottieAnimation
 
+from sticker_convert.definitions import SVG_DEFAULT_HEIGHT, SVG_DEFAULT_WIDTH, SVG_SAMPLE_FPS
+
+warnings.filterwarnings("ignore", category=XMLParsedAsHTMLWarning)
+
 
 def lcm(a: int, b: int):
     return abs(a * b) // gcd(a, b)
@@ -90,11 +96,17 @@ class CodecInfo:
             self.file_ext = CodecInfo.get_file_ext(file)
         else:
             self.file_ext = file_ext
-        self.fps, self.frames, self.duration = CodecInfo.get_file_fps_frames_duration(
-            file
-        )
-        self.codec = CodecInfo.get_file_codec(file)
-        self.res = CodecInfo.get_file_res(file)
+        if self.file_ext == ".svg":
+            self.fps, self.frames, self.duration, self.res = CodecInfo.get_svg_info(
+                file
+            )
+            self.codec = "svg"
+        else:
+            self.fps, self.frames, self.duration = (
+                CodecInfo.get_file_fps_frames_duration(file)
+            )
+            self.codec = CodecInfo.get_file_codec(file)
+            self.res = CodecInfo.get_file_res(file)
         self.is_animated = self.fps > 1
 
     @staticmethod
@@ -435,3 +447,38 @@ class CodecInfo:
         if CodecInfo.get_file_frames(file, check_anim=True) > 1:
             return True
         return False
+
+    @staticmethod
+    def get_svg_info(
+        file: Union[Path, bytes],
+    ) -> Tuple[float, int, int, Tuple[int, int]]:
+        if isinstance(file, Path):
+            with open(file) as f:
+                svg = f.read()
+        else:
+            svg = file.decode()
+
+        soup = BeautifulSoup(svg, "html.parser")
+        svg_tag = soup.find_all("svg")[0]
+        width = int(svg_tag.get("width", SVG_DEFAULT_WIDTH))
+        height = int(svg_tag.get("height", SVG_DEFAULT_HEIGHT))
+
+        animate_elements = [*soup.find_all("animate")] + [
+            *soup.find_all("animateTransform")
+        ]
+        duration = 0
+        for element in animate_elements:
+            dur = cast(str, element.get("dur"))
+            if dur.endswith("s"):
+                duration = int(max(duration, float(dur[:-1]) * 1000))
+            elif dur.endswith("ms"):
+                duration = int(max(duration, float(dur[:-2])))
+
+        if duration != 0:
+            fps = SVG_SAMPLE_FPS
+            frames = ceil(fps * duration / 1000)
+        else:
+            fps = 0
+            frames = 1
+
+        return fps, frames, duration, (width, height)

{sticker_convert-2.11.9 → sticker_convert-2.12.1}/src/sticker_convert/version.py

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

{sticker_convert-2.11.9 → sticker_convert-2.12.1/src/sticker_convert.egg-info}/PKG-INFO

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

{sticker_convert-2.11.9 → sticker_convert-2.12.1}/tests/test_download.py

@@ -473,6 +473,34 @@ def test_download_viber_official_sticker_packs(tmp_path: LocalPath) -> None:
     )
 
 
+@pytest.mark.skipif(not TEST_DOWNLOAD, reason="TEST_DOWNLOAD not set")
+def test_download_viber_official_sticker_packs_sound(tmp_path: LocalPath) -> None:
+    _run_sticker_convert(
+        tmp_path=tmp_path,
+        source="viber",
+        url="https://stickers.viber.com/pages/onenationunderloveUA",
+        expected_file_count=24,
+        expected_file_formats=[".png", ".mp3"],
+        with_title=True,
+        with_author=False,
+        with_emoji=False,
+    )
+
+
+@pytest.mark.skipif(not TEST_DOWNLOAD, reason="TEST_DOWNLOAD not set")
+def test_download_viber_official_sticker_packs_animated(tmp_path: LocalPath) -> None:
+    _run_sticker_convert(
+        tmp_path=tmp_path,
+        source="viber",
+        url="https://stickers.viber.com/pages/earthday",
+        expected_file_count=32,
+        expected_file_formats=[".svg"],
+        with_title=True,
+        with_author=False,
+        with_emoji=False,
+    )
+
+
 @pytest.mark.skipif(not TEST_DOWNLOAD, reason="TEST_DOWNLOAD not set")
 def test_download_discord_stickers(tmp_path: LocalPath) -> None:
     _run_sticker_convert(