use fps instead of frameskip and allow format filter

Author: FredHappyface

documentation/reference/tstickers/cli.md

@@ -9,7 +9,7 @@
 
 ## cli
 
-[Show source in cli.py:18](../../../tstickers/cli.py#L18)
+[Show source in cli.py:20](../../../tstickers/cli.py#L20)
 
 Cli entry point.
 

documentation/reference/tstickers/convert.md

@@ -27,37 +27,38 @@ class Backend(IntEnum): ...
 
 ## convertAnimated
 
-[Show source in convert.py:90](../../../tstickers/convert.py#L90)
+[Show source in convert.py:87](../../../tstickers/convert.py#L87)
 
-Convert animated stickers to webp, gif and png.
+Convert animated stickers, over a number of threads, at a given framerate, scale and to a
+set of formats.
 
 #### Arguments
 
-----
- - `swd` *Path* - the sticker working directory (downloads/packName)
- - `threads` *int, optional* - number of threads to pass to ThreadPoolExecutor. Defaults
-  to number of cores/ logical processors.
- - `frameSkip` *int, optional* - skip n number of frames in the interest of
- optimisation with a quality trade-off. Defaults to 1.
- - `scale` *float, optional* - upscale/ downscale the images produced. Intended
- for optimisation with a quality trade-off. Defaults to 1.
- - `backend` *Backend* - The backend to use for conversion. Defaults to Backend.UNDEFINED,
-allowing the system to determine the appropriate library to use.
+- `swd` *Path* - The sticker working directory (e.g., downloads/packName).
+- `threads` *int* - Number of threads for ProcessPoolExecutor (default: number of
+logical processors).
+- `fps` *int* - framerate of the converted sticker, affecting optimization and
+quality (default: 20)
+- `scale` *float* - Scale factor for up/downscaling images, affecting optimization and
+quality (default: 1).
+:param set[str]|None formats: Set of formats to convert telegram tgs stickers to
+(default: {"gif", "webp", "apng"})
 
 #### Returns
 
--------
- - `int` - number of stickers successfully converted
+Type: *int*
+Number of stickers successfully converted.
 
 #### Signature
 
 ```python
 def convertAnimated(
     swd: Path,
     threads: int = multiprocessing.cpu_count(),
-    frameSkip: int = 1,
+    fps: int = 20,
     scale: float = 1,
     backend: Backend = Backend.UNDEFINED,
+    formats: set[str] | None = None,
 ) -> int: ...
 ```
 
@@ -77,33 +78,37 @@ Convert animated stickers with (Base/Backend.UNDEFINED).
 
 ```python
 def convertAnimatedFunc(
-    _swd: Path, _threads: int, _frameSkip: int, _scale: float
+    _swd: Path, _threads: int, _fps: int, _scale: float, _formats
 ) -> int: ...
 ```
 
 
 
 ## convertStatic
 
-[Show source in convert.py:58](../../../tstickers/convert.py#L58)
+[Show source in convert.py:56](../../../tstickers/convert.py#L56)
 
-Convert static stickers to png and gif.
+Convert static stickers to specified formats.
 
 #### Arguments
 
-----
- - `swd` *Path* - the sticker working directory (downloads/packName)
- - `threads` *int, optional* - number of threads to pass to ThreadPoolExecutor. Defaults to 4.
+- `swd` *Path* - The sticker working directory (e.g., downloads/packName).
+- `threads` *int* - Number of threads for ProcessPoolExecutor (default: number of
+logical processors).
+:param set[str]|None formats: Set of formats to convert telegram webp stickers to
+(default: {"gif", "png", "webp", "apng"})
 
 #### Returns
 
--------
- - `int` - number of stickers successfully converted
+Type: *int*
+Number of stickers successfully converted.
 
 #### Signature
 
 ```python
-def convertStatic(swd: Path, threads: int = 4) -> int: ...
+def convertStatic(
+    swd: Path, threads: int = 4, formats: set[str] | None = None
+) -> int: ...
 ```
 
 
@@ -112,20 +117,20 @@ def convertStatic(swd: Path, threads: int = 4) -> int: ...
 
 [Show source in convert.py:38](../../../tstickers/convert.py#L38)
 
-Convert the webp file to png.
+Convert a webp file to specified formats.
 
 #### Arguments
 
-----
- - `inputFile` *str* - path to input file
+- `input_file` *Path* - path to the input image/ sticker
+:param set[str] formats: set of formats
 
 #### Returns
 
--------
- - `str` - path to input file
+Type: *Path*
+path of the original image/sticker file
 
 #### Signature
 
 ```python
-def convertWithPIL(inputFile: str) -> str: ...
+def convertWithPIL(input_file: Path, formats: set[str]) -> Path: ...
 ```

documentation/reference/tstickers/convert_pyrlottie.md

@@ -9,29 +9,34 @@
 
 ## convertAnimated
 
-[Show source in convert_pyrlottie.py:26](../../../tstickers/convert_pyrlottie.py#L26)
+[Show source in convert_pyrlottie.py:17](../../../tstickers/convert_pyrlottie.py#L17)
 
-Convert animated stickers to webp, gif and png.
+Convert animated stickers, over a number of threads, at a given framerate, scale and to a
+set of formats.
 
 #### Arguments
 
-----
- - `swd` *Path* - the sticker working directory (downloads/packName)
- - `threads` *int, optional* - number of threads to pass to ThreadPoolExecutor. Defaults to 4.
- - `frameSkip` *int, optional* - skip n number of frames in the interest of
- optimisation with a quality trade-off. Defaults to 1.
- - `scale` *float, optional* - upscale/ downscale the images produced. Intended
- for optimisation with a quality trade-off. Defaults to 1.
+- `swd` *Path* - The sticker working directory (e.g., downloads/packName).
+- `_threads` *int* - This is ignored for the pyrlottie backend
+- `fps` *int* - framerate of the converted sticker, affecting optimization and
+quality (default: 20)
+- `scale` *float* - Scale factor for up/downscaling images, affecting optimization and
+quality (default: 1).
+:param set[str] | None _formats: This is ignored for the pyrlottie backend
 
 #### Returns
 
--------
- - `int` - number of stickers successfully converted
+Type: *int*
+Number of stickers successfully converted.
 
 #### Signature
 
 ```python
 def convertAnimated(
-    swd: Path, _threads: int = 4, frameSkip: int = 1, scale: float = 1
+    swd: Path,
+    _threads: int = 4,
+    fps: int = 20,
+    scale: float = 1,
+    _formats: set[str] | None = None,
 ) -> int: ...
 ```

documentation/reference/tstickers/convert_rlottie_python.md

@@ -10,45 +10,67 @@
 
 ## convertAnimated
 
-[Show source in convert_rlottie_python.py:49](../../../tstickers/convert_rlottie_python.py#L49)
+[Show source in convert_rlottie_python.py:59](../../../tstickers/convert_rlottie_python.py#L59)
 
-Convert animated stickers to webp, gif and png.
+Convert animated stickers, over a number of threads, at a given framerate, scale and to a
+set of formats.
 
 #### Arguments
 
-----
- - `swd` *Path* - the sticker working directory (downloads/packName)
- - `threads` *int, optional* - number of threads to pass to ProcessPoolExecutor. Defaults
-  to number of cores/ logical processors.
- - `frameSkip` *int, optional* - skip n number of frames in the interest of
- optimisation with a quality trade-off. Defaults to 1.
- - `scale` *float, optional* - upscale/ downscale the images produced. Intended
- for optimisation with a quality trade-off. Defaults to 1.
+- `swd` *Path* - The sticker working directory (e.g., downloads/packName).
+- `threads` *int* - Number of threads for ProcessPoolExecutor (default: number of
+logical processors).
+- `fps` *int* - framerate of the converted sticker, affecting optimization and
+quality (default: 20)
+- `scale` *float* - Scale factor for up/downscaling images, affecting optimization and
+quality (default: 1).
+:param set[str]|None formats: Set of formats to convert telegram tgs stickers to
+(default: {"gif", "webp", "apng"})
 
 #### Returns
 
--------
- - `int` - number of stickers successfully converted
+Type: *int*
+Number of stickers successfully converted.
 
 #### Signature
 
 ```python
 def convertAnimated(
     swd: Path,
     threads: int = multiprocessing.cpu_count(),
-    frameSkip: int = 1,
+    fps: int = 20,
     scale: float = 1,
+    formats: set[str] | None = None,
 ) -> int: ...
 ```
 
 
 
 ## convert_single_tgs
 
-[Show source in convert_rlottie_python.py:26](../../../tstickers/convert_rlottie_python.py#L26)
+[Show source in convert_rlottie_python.py:18](../../../tstickers/convert_rlottie_python.py#L18)
+
+Convert a single tgs file.
+
+#### Arguments
+
+- `stckr` *Path* - Path to the sticker
+- `fps` *int* - framerate of the converted sticker, affecting optimization and
+quality (default: 20)
+- `scale` *float* - Scale factor for up/downscaling images, affecting optimization and
+quality (default: 1).
+:param set[str]|None formats: Set of formats to convert telegram tgs stickers to
+(default: {"gif", "webp", "apng"})
+
+#### Returns
+
+Type: *int*
+1 if success
 
 #### Signature
 
 ```python
-def convert_single_tgs(stckr: Path, fps: int, scale: float = 1.0) -> int: ...
+def convert_single_tgs(
+    stckr: Path, fps: int, scale: float = 1.0, formats: set[str] | None = None
+) -> int: ...
 ```

documentation/reference/tstickers/manager.md

@@ -77,31 +77,33 @@ class StickerManager:
 
 ### StickerManager().convertPack
 
-[Show source in manager.py:256](../../../tstickers/manager.py#L256)
+[Show source in manager.py:248](../../../tstickers/manager.py#L248)
 
-Convert the webp to gif and png; tgs to gif, webp (webp_animated) and png.
+Convert a downloaded sticker pack given by packName to other formats specified.
 
 #### Arguments
 
-----
- - `packName` *str* - name of the directory to convert
- - `frameSkip` *int, optional* - skip n number of frames in the interest of
- optimisation with a quality trade-off. Defaults to 1.
- - `scale` *float, optional* - upscale/ downscale the images produced. Intended
- for optimisation with a quality trade-off. Defaults to 1.
- - `noCache` *bool, optional* - set to true to disable cache. Defaults to False.
- - `backend` *Backend* - select the backend to use to convert animated stickers
+- `packName` *str* - name of the pack to convert
+- `fps` *int* - framerate of animated stickers, affecting optimization and
+quality (default: 20)
+- `scale` *float* - Scale factor of animated stickers, for up/downscaling images,
+affecting optimization and quality (default: 1).
+- `noCache` *bool* - set to true to disable cache. Defaults to False.
+- `backend` *Backend* - select the backend to use to convert animated stickers
+:param set[str]|None formats: Set of formats to convert telegram tgs stickers to
+(default: {"gif", "webp", "apng"})
 
 #### Signature
 
 ```python
 def convertPack(
     self,
     packName: str,
-    frameSkip: int = 1,
+    fps: int = 20,
     scale: float = 1,
     noCache: bool = False,
     backend: Backend = Backend.UNDEFINED,
+    formats: set[str] | None = None,
 ) -> None: ...
 ```
 
@@ -139,19 +141,18 @@ def doAPIReq(self, function: str, params: dict[Any, Any]) -> dict[Any, Any] | No
 
 ### StickerManager().downloadPack
 
-[Show source in manager.py:210](../../../tstickers/manager.py#L210)
+[Show source in manager.py:207](../../../tstickers/manager.py#L207)
 
 Download a sticker pack.
 
 #### Arguments
 
-----
- - `packName` *str* - name of the pack
+- `packName` *str* - name of the pack
 
 #### Returns
 
--------
- - `bool` - success
+Type: *bool*
+success
 
 #### Signature
 
@@ -167,14 +168,13 @@ Download a sticker from the server.
 
 #### Arguments
 
-----
- - `path` *Path* - the path to write to
- - `link` *str* - the url to the file on the server
+- `path` *Path* - the path to write to
+- `link` *str* - the url to the file on the server
 
 #### Returns
 
--------
- - `int` - path.write_bytes(res.content)
+Type: *int*
+path.write_bytes(res.content)
 
 #### Signature