Use kimageformats to decode AVIF (#230)

SevenTV · Aug 20, 2023 · 42bd526 · 42bd526 · KogasaPls · Sep 2, 2023
1 parent 6c2fe51
commit 42bd526
Show file tree

Hide file tree

Showing 18 changed files with 568 additions and 16 deletions.
diff --git a/.CI/CreateUbuntuDeb.sh b/.CI/CreateUbuntuDeb.sh
@@ -21,14 +21,14 @@ deb_path="Chatterino-ubuntu-${ubuntu_release}-x86_64.deb"
 # Refactor opportunity:
 case "$ubuntu_release" in
     20.04)
-        dependencies="libc6, libstdc++6, libqt5core5a, libqt5concurrent5, libqt5dbus5, libqt5gui5, libqt5network5, libqt5svg5, libqt5widgets5, qt5-image-formats-plugins, libboost-filesystem1.71.0"
+        dependencies="libc6, libstdc++6, libqt5core5a, libqt5concurrent5, libqt5dbus5, libqt5gui5, libqt5network5, libqt5svg5, libqt5widgets5, qt5-image-formats-plugins, libboost-filesystem1.71.0, libavif"
         ;;
     22.04)
         if [ -n "$Qt6_DIR" ]; then
             echo "Qt6_DIR set, assuming Qt6"
-            dependencies="libc6, libstdc++6, libqt6core6, libqt6widgets6, libqt6network6, libqt6core5compat6, libqt6svg6, qt6-qpa-plugins, qt6-image-formats-plugins"
+            dependencies="libc6, libstdc++6, libqt6core6, libqt6widgets6, libqt6network6, libqt6core5compat6, libqt6svg6, qt6-qpa-plugins, qt6-image-formats-plugins, libavif"
         else
-            dependencies="libc6, libstdc++6, libqt5core5a, libqt5concurrent5, libqt5dbus5, libqt5gui5, libqt5network5, libqt5svg5, libqt5widgets5, qt5-image-formats-plugins, libboost-filesystem1.74.0"
+            dependencies="libc6, libstdc++6, libqt5core5a, libqt5concurrent5, libqt5dbus5, libqt5gui5, libqt5network5, libqt5svg5, libqt5widgets5, qt5-image-formats-plugins, libboost-filesystem1.74.0, libavif"
         fi
         ;;
     *)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -307,7 +307,8 @@ jobs:
             libboost-dev, libboost-system-dev, libboost-filesystem-dev,
             libssl-dev,
             rapidjson-dev,
-            libbenchmark-dev
+            libbenchmark-dev,
+            libavif-dev
 
       - name: clang-tidy-review upload
         if: matrix.clang-tidy-review && github.event_name == 'pull_request'
@@ -345,7 +346,7 @@ jobs:
       - name: Install dependencies (MacOS)
         if: startsWith(matrix.os, 'macos')
         run: |
-          brew install boost openssl rapidjson p7zip create-dmg cmake tree
+          brew install boost openssl rapidjson p7zip create-dmg cmake tree libavif
         shell: bash
 
       - name: Build (MacOS)

diff --git a/.gitmodules b/.gitmodules
@@ -41,3 +41,6 @@
 [submodule "lib/crashpad"]
 	path = lib/crashpad
 	url = https://github.com/getsentry/crashpad
+[submodule "lib/kimageformats"]
+	path = lib/kimageformats
+	url = https://github.com/KDE/kimageformats
diff --git a/BUILDING_ON_LINUX.md b/BUILDING_ON_LINUX.md
@@ -8,23 +8,23 @@ Note on Qt version compatibility: If you are installing Qt from a package manage
 
 _Most likely works the same for other Debian-like distros_
 
-Install all of the dependencies using `sudo apt install qttools5-dev qt5-image-formats-plugins libqt5svg5-dev libboost-dev libssl-dev libboost-system-dev libboost-filesystem-dev cmake g++ libsecret-1-dev`
+Install all of the dependencies using `sudo apt install qttools5-dev qt5-image-formats-plugins libqt5svg5-dev libboost-dev libssl-dev libboost-system-dev libboost-filesystem-dev cmake g++ libsecret-1-dev libavif-dev`
 
 ### Arch Linux
 
-Install all of the dependencies using `sudo pacman -S --needed qt5-base qt5-imageformats qt5-svg qt5-tools boost rapidjson pkgconf openssl cmake`
+Install all of the dependencies using `sudo pacman -S --needed qt5-base qt5-imageformats qt5-svg qt5-tools boost rapidjson pkgconf openssl cmake libavif-git`
 
 Alternatively you can use the [chatterino2-git](https://aur.archlinux.org/packages/chatterino2-git/) package to build and install Chatterino for you.
 
 ### Fedora 28 and above
 
 _Most likely works the same for other Red Hat-like distros. Substitute `dnf` with `yum`._
 
-Install all of the dependencies using `sudo dnf install qt5-qtbase-devel qt5-imageformats qt5-qtsvg-devel qt5-linguist libsecret-devel openssl-devel boost-devel cmake`
+Install all of the dependencies using `sudo dnf install qt5-qtbase-devel qt5-imageformats qt5-qtsvg-devel qt5-linguist libsecret-devel openssl-devel boost-devel cmake libavif-devel`
 
 ### NixOS 18.09+
 
-Enter the development environment with all of the dependencies: `nix-shell -p openssl boost qt5.full pkg-config cmake`
+Enter the development environment with all of the dependencies: `nix-shell -p openssl boost qt5.full pkg-config cmake libavif`
 
 ## Compile
 

diff --git a/BUILDING_ON_MAC.md b/BUILDING_ON_MAC.md
@@ -10,7 +10,7 @@ Local dev machines for testing are available on Apple Silicon on macOS 13.
 1. Install [Homebrew](https://brew.sh/#install)  
    We use this for dependency management on macOS
 1. Install all dependencies:  
-   `brew install boost [email protected] rapidjson cmake qt@5`
+   `brew install boost [email protected] rapidjson cmake qt@5 libavif`
 
 ## Building
 

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -223,6 +223,8 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 # Generate resource files
 include(cmake/resources/generate_resources.cmake)
 
+add_subdirectory(${CMAKE_SOURCE_DIR}/lib/qt-plugins)
+
 add_subdirectory(src)
 
 if (BUILD_TESTS OR BUILD_BENCHMARKS)

diff --git a/cmake/AVIF.cmake b/cmake/AVIF.cmake
@@ -0,0 +1,10 @@
+find_package(libavif)
+
+if (libavif_FOUND)
+    set(kimageformats_SRC ${CMAKE_SOURCE_DIR}/lib/kimageformats/src/imageformats)
+
+    add_library(kimageformats STATIC ${kimageformats_SRC}/avif.cpp)
+    set_target_properties(kimageformats PROPERTIES AUTOMOC ON)
+    target_link_libraries(kimageformats PRIVATE Qt${MAJOR_QT_VERSON}::Gui avif)
+    target_compile_definitions(kimageformats PRIVATE QT_STATICPLUGIN)
+endif()
diff --git a/conanfile.py b/conanfile.py
@@ -5,7 +5,7 @@
 
 class Chatterino(ConanFile):
     name = "Chatterino"
-    requires = "boost/1.81.0"
+    requires = "boost/1.81.0", "libavif/0.11.1"
     settings = "os", "compiler", "build_type", "arch"
     default_options = {
         "with_benchmark": False,

diff --git a/lib/kimageformats b/lib/kimageformats
diff --git a/lib/qt-plugins/CMakeLists.txt b/lib/qt-plugins/CMakeLists.txt
@@ -0,0 +1,10 @@
+include(${CMAKE_SOURCE_DIR}/cmake/AVIF.cmake)
+
+add_library(chatterino-qt-plugins OBJECT ${CMAKE_CURRENT_LIST_DIR}/QtPlugins.cpp)
+target_link_libraries(chatterino-qt-plugins PRIVATE Qt${MAJOR_QT_VERSION}::Core Qt${MAJOR_QT_VERSION}::Gui)
+target_compile_definitions(chatterino-qt-plugins PRIVATE QT_STATICPLUGIN)
+
+if (libavif_FOUND)
+    target_compile_definitions(chatterino-qt-plugins PRIVATE WITH_AVIF)
+    target_link_libraries(chatterino-qt-plugins PRIVATE kimageformats)
+endif()
diff --git a/lib/qt-plugins/QtPlugins.cpp b/lib/qt-plugins/QtPlugins.cpp
@@ -0,0 +1,7 @@
+#pragma once
+
+#include <QtCore/QtPlugin>
+
+#ifdef WITH_AVIF
+Q_IMPORT_PLUGIN(QAVIFPlugin)
+#endif