Merge branch 'unstable' into stable for 1.0.0 release

Author: JacobDev1

LICENSE.txt

@@ -2,45 +2,7 @@ XL Converter is licensed under GNU General Public License v3.
 
 Copyright (c) 2023 - 2024 Code Poems <contact@codepoems.eu>
 
----------------------------------------------------------------------------------
-
-This End-User License Agreement ("EULA") is a legal agreement between you (either an individual or an entity) and the software program's authors and contributors, for the software product accompanying this EULA, which includes computer software and may include associated media, printed materials, and "online" or electronic documentation ("Software").
-
-By installing, copying, or otherwise using the Software, you agree to be bound by the terms of this EULA, which incorporates the terms and conditions of the GNU General Public License Version 3 (GPLv3) as published by the Free Software Foundation. If you do not agree to the terms of this EULA, do not install or use the Software.
-
-COPYRIGHT: The Software is copyrighted and licensed (not sold) to you. The Software is protected by copyright laws and treaties around the world. All rights not expressly granted to you by this EULA are reserved by the copyright owners.
-
-LICENSE: The Software is licensed under the GNU General Public License Version 3 (GPLv3), the terms of which are incorporated herein by reference. By installing, copying, or using the Software you acknowledge that you have read the GPLv3, understand it, and agree to be bound by its terms and conditions. The GPLv3 can be obtained at: http://www.gnu.org/licenses/gpl-3.0.html
-
-LICENSE GRANT: This EULA grants you the following rights, subject to the terms of the GPLv3:
-- You may copy, distribute, and modify the software provided that you track changes/dates in source files and keep intact all notices on the original software.
-- You may distribute the software to anyone and for any purpose and charge no more than the cost of distributing the software.
-- You may use portions of the software independently of the complete program.
-- Works that you distribute or publish that contain or are derived from the Software or any part thereof must be licensed as a whole at no charge to all third parties under the terms of this License (GPLv3).
-
-UPDATE FEATURE: The Software includes a feature to check for updates, which requires the transmission of the user's Internet Protocol (IP) address to a server in order to obtain a text file for the update process. By using this feature, you acknowledge and consent to the transmission of your IP address for this purpose. The IP address is used solely for fetching the necessary update information and will not be used for any other purposes. While the IP address may be stored for a period of up to 12 months, it is typically stored for a shorter period.
-
-WEB LINK FEATURE: The Software includes a feature that opens a link to our webpage or our GitHub repository. By using this feature, you acknowledge and consent to the Software initiating an external connection to these sites. Please note that our webpage and GitHub repository are governed by their own terms of service and privacy policies, which we encourage you to review.
-
-PRIVACY: The author prioritizes your privacy. Apart from the IP address used for the update feature, no other personal data is collected from you without your explicit consent.
-
-DISCLAIMER OF WARRANTY: The Software is provided "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the Software is with you.
-
-LIMITATION OF LIABILITY: Except as mandated by law or as explicitly agreed upon in a written contract, neither copyright owners nor any individuals or entities that amend and/or distribute the Software under GPLv3 shall bear financial responsibility to you for any form of loss or damage. This exclusion of liability encompasses a wide range of potential issues, such as general, specific, unplanned, or secondary harm that may arise from utilizing or the failure to use the Software. Potential issues covered include, but are not limited to, data loss, data corruption, any harm suffered by you or third parties, or the inability of the Software to function with other software systems, even if such copyright owner or entity has been previously notified about the risk of such damages.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-TERMINATION: This EULA and your rights under it will terminate automatically without notice from the copyright owner if you fail to comply with any of its terms and conditions, including but not limited to the terms of the GNU General Public License Version 3 (GPLv3).
-
-MISCELLANEOUS: This EULA is governed by the laws of the jurisdiction in which the copyright owner resides. If any part of this EULA is found to be void, invalid, or unenforceable, it will not affect the validity of the balance of the EULA, which shall remain valid and enforceable according to its terms.
-
-ENTIRE AGREEMENT: This EULA (including the GPLv3) is the entire agreement between you and the copyright owner relating to the Software and supersedes all prior or contemporaneous oral or written communications, proposals, and representations with respect to the Software or any other subject matter covered by this EULA.
-
-By installing, copying, or using the Software you acknowledge that you have read this EULA, understand it, and agree to be bound by its terms and conditions. You also agree that this EULA is the complete and exclusive statement of the agreement between us and supersedes all proposals or prior agreements, oral or written, and any other communications relating to the subject matter of this EULA.
-
-You can contact me at this email address: contact@codepoems.eu
-
------------------------------------------------------------------------------------
+-------------------------- BEGIN LICENSE --------------------------
 
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
@@ -716,4 +678,14 @@ into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
+
+--------------------------- END LICENSE ---------------------------
+
+----------------------- BEGIN PRIVACY POLICY ----------------------
+
+WEB LINK FEATURE: This Software includes a feature that opens a link to our webpage or GitHub repository. By using this feature, you consent to the Software initiating an external connection to these sites. Be aware that these sites have their own terms of service and privacy policies, which you should review.
+
+UPDATE FEATURE: The Software includes a feature to check for updates, which requires the transmission of the user's Internet Protocol (IP) address to a server in order to obtain a text file for the update process. By using this feature, you acknowledge and consent to the transmission of your IP address for this purpose. The IP address is used solely for fetching the necessary update information and will not be used for any other purposes. While the IP address may be stored for a period of up to 12 months.
+
+----------------------- END PRIVACY POLICY ------------------------

README.md

@@ -1,6 +1,5 @@
-<p align="center">
+<div align="center">
     <img src="icons/logo.svg" width="20%">
-</p>
 <h3 align="center">XL Converter</h3>
 
 Powerful image converter for the latest formats with support for multithreading, drag 'n drop, and downscaling.
@@ -9,7 +8,8 @@ Available for Windows and Linux.
 
 ![](misc/screenshots/screenshot_0.png)
 
-The [documentation](https://xl-docs.codepoems.eu)
+Read the [Manual](https://xl-docs.codepoems.eu)
+</div>
 
 ## Supported Formats
 
@@ -20,13 +20,13 @@ Encode to **JPEG XL, AVIF, WEBP, and JPG**. Convert from **HEIF** and [more](htt
 
 Just drop your images and convert. XL Converter works out of the box with no setup or steep learning curve. It prioritizes user experience while granting access to cutting-edge technology.
 
-#### JPG Reconstruction
+#### Parallel Encoding
 
-Losslessly transcode JPG to JPEG XL, reverse the process when needed.
+Encode images in parallel to speed up the process. Control how much CPU to use during encoding.
 
-#### Multithreading
+#### JPG Reconstruction
 
-Use as many CPU cores as you want.
+Losslessly transcode JPG to JPEG XL, and reverse the process when needed.
 
 #### Image Proxy
 
@@ -52,7 +52,7 @@ Easily copy and wipe metadata using encoder parameters or ExifTool.
 
 #### JPEGLI
 
-Encode to regular JPG using the highest quality encoder available.
+Generate the highest quality (regular old) JPGs with JPEGLI. 
 
 ## Bug Reports
 
@@ -68,10 +68,13 @@ Feel free to make bug reports as contributions.
 
 ## Building from Source
 
+> [!NOTE]
+> The recommended way of using XL Converter is through the [official binary releases](https://codepoems.eu/xl-converter). The building process is time-consuming and tedious.
+
 ### Windows 10
 
-Prerequisites:
-- Python `3.11.6` (with `pip`)
+Install:
+- Python `3.11.9` (with `pip`)
 - `git`
 
 Clone the repo.
@@ -111,8 +114,28 @@ Install packages.
 
 ```bash
 sudo apt update
-sudo apt install python3 python3-pip python3-venv git
-sudo apt install '^libxcb.*-dev' libx11-xcb-dev libglu1-mesa-dev libxrender-dev libxi-dev libxkbcommon-dev libxkbcommon-x11-dev
+sudo apt install git make
+```
+
+Install [xcb QPA](https://doc.qt.io/qt-6/linux-requirements.html) dependencies.
+
+```bash
+sudo apt install '^libxcb.*-dev' libfontconfig1-dev libfreetype6-dev libx11-dev libx11-xcb-dev libxext-dev libxfixes-dev libglu1-mesa-dev libxrender-dev libxi-dev libxkbcommon-dev libxkbcommon-x11-dev
+```
+
+Install [pyenv](https://github.com/pyenv/pyenv) via [Automatic installer](https://github.com/pyenv/pyenv?tab=readme-ov-file#automatic-installer) then [add it to shell](https://github.com/pyenv/pyenv?tab=readme-ov-file#set-up-your-shell-environment-for-pyenv)
+
+Install Python build packages.
+
+```bash
+sudo apt install wget build-essential libreadline-dev libncursesw5-dev libssl-dev libsqlite3-dev tk-dev libgdbm-dev libc6-dev libbz2-dev libffi-dev zlib1g-dev liblzma-dev
+```
+
+Build and setup Python `3.11.9`.
+
+```bash
+pyenv install 3.11.9
+pyenv local 3.11.9
 ```
 
 Clone and set up the repo.
@@ -159,52 +182,41 @@ Extra building modes:
 To build XL Converter, you need to provide various binaries. This can be quite challenging.
 
 Binaries needed:
-- [libjxl](https://github.com/libjxl/libjxl) 0.10.2
+- [libjxl](https://github.com/libjxl/libjxl) `0.10.2` ([with this patch on Windows](https://github.com/JacobDev1/libjxl-utf8))
     - cjxl
     - djxl
     - jxlinfo
     - cjpegli
-- [libavif](https://github.com/AOMediaCodec/libavif) 1.0.3 (**AVIF_CODEC_AOM**)
+- [libavif](https://github.com/AOMediaCodec/libavif) `1.0.4` (AOM `3.8.2`)
     - avifenc
     - avifdec
-- [imagemagick](https://imagemagick.org/) 7.1.1-15 Q16-HDRI
+- [imagemagick](https://imagemagick.org/) `7.1.1-15 Q16-HDRI`
     - magick - AppImage for Linux
     - magick.exe - Windows
-- [exiftool](https://exiftool.org/) 12.77
+- [exiftool](https://exiftool.org/) `12.77`
     - exiftool.exe - Windows
     - exiftool - standalone Perl build
-- [oxipng](https://github.com/shssoichiro/oxipng) 0.8.0
+- [oxipng](https://github.com/shssoichiro/oxipng) `0.9.0`
 
 Place them in the following directories:
 - `xl-converter\bin\win` for Windows (x86_64) 
 - `xl-converter/bin/linux` for Linux (x86_64) 
 
 All binaries are built statically. The version numbers should match. Binaries on Windows have an `.exe` extension.
 
-See the official [XL Converter builds](https://github.com/JacobDev1/xl-converter/releases) for examples.
+> [!TIP]
+> See the official [XL Converter builds](https://github.com/JacobDev1/xl-converter/releases) for examples.
 
 ## Info
 
-### Python Version
-
-The project runs on Python `3.11.6`. It should also work on a slightly older version. `3.12` and newer are not supported.
-
-### Large Files
-
-Don't forget `--depth 1` when running `git clone`. This repo contains large files.
+> [!IMPORTANT]
+> This project runs on Python `3.11`. Other versions are not supported.
 
-### Development Branch
-
-The dev branch can be accessed with
-
-```bash
-git clone -b unstable --depth 1 https://github.com/JacobDev1/xl-converter.git
-```
+> [!NOTE]
+> Don't forget `--depth 1` when running `git clone` to avoid large files.
 
 ## Unit Testing
 
-Unit tests are currently being reworked.
-
 ### Running
 
 [Setup repo](#building-from-source).
@@ -218,24 +230,16 @@ pip install -r requirements.txt
 pip install -r requirements_test.txt
 ```
 
-Run tests (Linux)
-
-```bash
-make test
-```
-
-Run tests (Windows)
+Run tests
 
 ```cmd
 python test.py
 ```
 
 ### Deprecated
 
-`tests_old.py` is a deprecated, but still accessible test suite.
-
-To run them, put any image with a varying aspect ratio inside a `sample_img` folder in the project's directory.
+`test_old.py` is a deprecated, but still accessible test suite focusing on the conversion results.
 
 ```bash
-python tests_old.py
+python test_old.py
 ```

build.py

@@ -225,7 +225,7 @@ def build(self):
         self._appendInstaller()
         self._appendDesktopEntry()
         self._appendMisc()
-        self._appendRedistributable()
+        self._downloadRedistributable()
         self._appendUpdateFile()
         self._finish()
 
@@ -300,15 +300,11 @@ def _appendMisc(self):
         copy(self.icon_svg_path, f"{self.internal_dir}/icons/{os.path.basename(self.icon_svg_path)}")
         copyTree(self.fonts_path, f"{self.internal_dir}/fonts")
 
-    def _appendRedistributable(self):
+    def _downloadRedistributable(self):
         if platform.system() != "Windows":
             return
 
         self.downloader.downloadRedistributable()
-        print("[Building] Appending redistributable")
-        redist_dst = f"{self.dst_dir}/{self.project_name}/redist"
-        makedirs(redist_dst)
-        copy(self.redist_path, redist_dst)
 
     def _appendUpdateFile(self):
         print("[Building] Appending an update file (to place on a server)")

core/proxy.py

@@ -1,5 +1,6 @@
 import os
 import logging
+import re
 
 from PySide6.QtCore import (
     QMutexLocker,
@@ -10,9 +11,12 @@
     ALLOWED_INPUT_CJPEGLI,
     ALLOWED_INPUT_AVIFENC,
     ALLOWED_INPUT_IMAGE_MAGICK,
+    IMAGE_MAGICK_PATH,
 )
 from core.pathing import getUniqueFilePath
 from core.convert import convert, getDecoder
+from core.process import runProcessOutput
+from core.exceptions import FileException
 
 class Proxy():
     def __init__(self):
@@ -54,6 +58,16 @@ def isProxyNeeded(self, _format, src_ext, jpegli=False, downscaling_enabled=Fals
 
     def generate(self, src, src_ext, dst_dir, file_name, n, mutex):
         """Generate a proxy image."""
+        if src_ext in ("tif", "tiff"):
+            try:
+                layers_re = re.search(r"\d+", runProcessOutput(IMAGE_MAGICK_PATH, "identify", "-format", "%n\n", src).decode("utf-8"))
+                layers_n = int(layers_re.group(0))
+            except Exception:
+                raise FileException("Proxy_0", "Cannot detect the number of pages.")
+
+            if layers_n != 1:
+                raise FileException("Proxy_1", "TIFFs with multiple pages are not supported.")
+        
         with QMutexLocker(mutex):
             self.proxy_path = getUniqueFilePath(dst_dir, file_name, "png", True)