Merge pull request #255 from Tom94/support-avif

feat: add support for .avif images

.gitmodules

@@ -1,45 +1,64 @@
 [submodule "dependencies/args"]
 	path = dependencies/args
 	url = https://github.com/Taywee/args
+	shallow = true
 [submodule "dependencies/Imath"]
 	path = dependencies/Imath
 	url = https://github.com/AcademySoftwareFoundation/Imath
+	shallow = true
 [submodule "dependencies/openexr"]
 	path = dependencies/openexr
 	url = https://github.com/AcademySoftwareFoundation/openexr
+	shallow = true
 [submodule "dependencies/zlib"]
 	path = dependencies/zlib
 	url = https://github.com/Tom94/zlib
+	shallow = true
 [submodule "dependencies/utfcpp"]
 	path = dependencies/utfcpp
 	url = https://github.com/Tom94/utfcpp
+	shallow = true
 [submodule "dependencies/tinylogger"]
 	path = dependencies/tinylogger
 	url = https://github.com/Tom94/tinylogger
+	shallow = true
 [submodule "dependencies/clip"]
 	path = dependencies/clip
 	url = https://github.com/Tom94/clip
+	shallow = true
 [submodule "dependencies/DirectXTex"]
 	path = dependencies/DirectXTex
 	url = https://github.com/Tom94/DirectXTex
+	shallow = true
 [submodule "dependencies/nanogui"]
 	path = dependencies/nanogui
 	url = https://github.com/Tom94/nanogui-1
+	shallow = true
 [submodule "dependencies/qoi"]
 	path = dependencies/qoi
 	url = https://github.com/phoboslab/qoi.git
+	shallow = true
 [submodule "dependencies/fmt"]
 	path = dependencies/fmt
 	url = https://github.com/fmtlib/fmt
+	shallow = true
 [submodule "scripts/create-dmg"]
 	path = scripts/create-dmg
 	url = https://github.com/create-dmg/create-dmg
+	shallow = true
 [submodule "dependencies/libdeflate"]
 	path = dependencies/libdeflate
 	url = https://github.com/ebiggers/libdeflate
+	shallow = true
 [submodule "dependencies/libheif"]
 	path = dependencies/libheif
 	url = https://github.com/Tom94/libheif
+	shallow = true
 [submodule "dependencies/libde265"]
 	path = dependencies/libde265
 	url = https://github.com/strukturag/libde265
+	shallow = true
+[submodule "dependencies/aom"]
+	path = dependencies/aom
+	url = https://github.com/Tom94/aom
+	shallow = true

CMakeLists.txt

@@ -20,9 +20,10 @@ elseif (CMAKE_SIZEOF_VOID_P EQUAL 4)
     set(TEV_VERSION_ARCH "${TEV_VERSION} (32 bit)")
 endif()
 
+option(TEV_SUPPORT_AVIF "Support loading AVIF images" ON)
 option(TEV_SUPPORT_HEIC "Support loading HEIC images" OFF)
 
-set(TEV_USE_LIBHEIF ${TEV_SUPPORT_HEIC}) # If other codecs supported by heif are used, adjust this condition.
+set(TEV_USE_LIBHEIF ${TEV_SUPPORT_AVIF} OR ${TEV_SUPPORT_HEIC})
 
 # Set ourselves as the startup project in visual studio.
 # Not available until cmake 3.6, but doesn't break older versions.
@@ -244,6 +245,9 @@ if (APPLE)
     # in keeping the warnings around.
     set(TEV_DEFINITIONS ${TEV_DEFINITIONS} -DGL_SILENCE_DEPRECATION)
 endif()
+if (TEV_SUPPORT_AVIF)
+    set(TEV_DEFINITIONS ${TEV_DEFINITIONS} -DTEV_SUPPORT_AVIF)
+endif()
 if (TEV_SUPPORT_HEIC)
     set(TEV_DEFINITIONS ${TEV_DEFINITIONS} -DTEV_SUPPORT_HEIC)
 endif()

README.md

@@ -146,6 +146,7 @@ $ cpack --config build/CPackConfig.cmake
 - __QOI__ (via [qoi](https://github.com/phoboslab/qoi). Shoutout to [Tiago Chaves](https://github.com/laurelkeys) for adding support!)
 - __DDS__ (via [DirectXTex](https://github.com/microsoft/DirectXTex); Windows only. Shoutout to [Craig Kolb](https://github.com/cek) for adding support!)
     - Supports BC1-BC7 compressed formats.
+- __AVIF__ (via [aom](https://aomedia.googlesource.com/aom)+[libheif](https://github.com/strukturag/libheif))
 - __HEIC__ (via [libde265](https://github.com/strukturag/libde265)+[libheif](https://github.com/strukturag/libheif); disabled in binary release. You must build __tev__ yourself with the `TEV_SUPPORT_HEIC` CMake option. Check patent laws in your juristiction before enabling this feature.)
 
 ## License

dependencies/CMakeLists.txt

@@ -49,24 +49,16 @@ if (WIN32)
     include_directories(${DIRECTXTEX_INCLUDE_DIR})
 endif()
 
-# Compile OpenEXR
-set(IMATH_INSTALL OFF CACHE BOOL " " FORCE)
-set(IMATH_INSTALL_PKG_CONFIG OFF CACHE BOOL " " FORCE)
-add_subdirectory(Imath)
-
-set(LIBDEFLATE_BUILD_SHARED_LIB OFF CACHE BOOL " " FORCE)
-set(LIBDEFLATE_BUILD_GZIP OFF CACHE BOOL " " FORCE)
-add_subdirectory(libdeflate EXCLUDE_FROM_ALL)
-
-set(OPENEXR_FORCE_INTERNAL_DEFLATE ON CACHE BOOL " " FORCE)
-set(EXR_DEFLATE_LIB libdeflate::libdeflate_static)
+# Compile aom (dependency of libheif, which follows)
+if (TEV_SUPPORT_AVIF)
+    set(AOM_TARGET_CPU "generic" CACHE STRING " " FORCE)
+    set(BUILD_SHARED_LIBS OFF CACHE BOOL " " FORCE)
+    set(ENABLE_DOCS OFF CACHE BOOL " " FORCE)
+    add_subdirectory(aom EXCLUDE_FROM_ALL)
 
-set(OPENEXR_INSTALL OFF CACHE BOOL " " FORCE)
-set(OPENEXR_INSTALL_TOOLS OFF CACHE BOOL " " FORCE)
-set(OPENEXR_INSTALL_PKG_CONFIG OFF CACHE BOOL " " FORCE)
-set(OPENEXR_BUILD_EXAMPLES OFF CACHE BOOL " " FORCE)
-set(OPENEXR_BUILD_TOOLS OFF CACHE BOOL " " FORCE)
-add_subdirectory(openexr)
+    set(AOM_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/aom" CACHE PATH " " FORCE)
+    set(AOM_LIBRARY aom)
+endif()
 
 # Compile libde265 (dependency of libheif, which follows)
 if (TEV_SUPPORT_HEIC)
@@ -76,7 +68,6 @@ if (TEV_SUPPORT_HEIC)
 
     set(LIBDE265_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/libde265" CACHE PATH " " FORCE)
     set(LIBDE265_LIBRARY de265)
-    include_directories("${CMAKE_CURRENT_BINARY_DIR}/libde265")
 endif()
 
 # Compile libheif
@@ -87,28 +78,55 @@ if (TEV_USE_LIBHEIF)
     set(WITH_EXAMPLES OFF CACHE BOOL " " FORCE)
     set(WITH_FUZZERS OFF CACHE BOOL " " FORCE)
     set(WITH_GDK_PIXBUF OFF CACHE BOOL " " FORCE)
+    set(WITH_INSTALL OFF CACHE BOOL " " FORCE)
 
     # Codecs
     set(WITH_LIBDE265 ${TEV_SUPPORT_HEIC})
     set(WITH_X265 OFF CACHE BOOL " " FORCE)
     set(WITH_OpenH264_ENCODER OFF CACHE BOOL " " FORCE)
     set(WITH_OpenH264_DECODER OFF CACHE BOOL " " FORCE)
 
-    # TODO: Add aom as dependency to let libheif decode avif images for us.
-    # Also consider adding JPEG2000 support via libheif.
     set(WITH_AOM_ENCODER OFF CACHE BOOL " " FORCE)
-    set(WITH_AOM_DECODER OFF CACHE BOOL " " FORCE)
+    set(WITH_AOM_DECODER ${TEV_SUPPORT_AVIF} CACHE BOOL " " FORCE)
+
+    # TODO: Also consider adding JPEG2000 support via libheif.
 
     # libsharpyuv is not needed for us, because we're not interested in converting from RGB to YUV. tev is primarily an image viewer that
     # goes from YUV to RGB upon loading images, where libsharpyuv does nothing. See https://www.ctrl.blog/entry/webp-sharp-yuv.html for more
     # info.
     set(WITH_LIBSHARPYUV OFF CACHE BOOL " " FORCE)
 
     add_subdirectory(libheif EXCLUDE_FROM_ALL)
+    target_include_directories(heif PRIVATE "${CMAKE_CURRENT_BINARY_DIR}/aom")
+    target_include_directories(heif PRIVATE "${CMAKE_CURRENT_BINARY_DIR}/libde265")
 
     set(LIBHEIF_INCLUDE "${CMAKE_CURRENT_SOURCE_DIR}/libheif/libheif/api" "${CMAKE_CURRENT_BINARY_DIR}/libheif" PARENT_SCOPE)
 endif()
 
+# Compile OpenEXR
+set(IMATH_INSTALL OFF CACHE BOOL " " FORCE)
+set(IMATH_INSTALL_PKG_CONFIG OFF CACHE BOOL " " FORCE)
+add_subdirectory(Imath)
+
+set(LIBDEFLATE_BUILD_SHARED_LIB OFF CACHE BOOL " " FORCE)
+set(LIBDEFLATE_BUILD_GZIP OFF CACHE BOOL " " FORCE)
+add_subdirectory(libdeflate EXCLUDE_FROM_ALL)
+
+set(OPENEXR_FORCE_INTERNAL_DEFLATE ON CACHE BOOL " " FORCE)
+set(EXR_DEFLATE_LIB libdeflate::libdeflate_static)
+
+set(OPENEXR_INSTALL OFF CACHE BOOL " " FORCE)
+set(OPENEXR_INSTALL_TOOLS OFF CACHE BOOL " " FORCE)
+set(OPENEXR_INSTALL_PKG_CONFIG OFF CACHE BOOL " " FORCE)
+set(OPENEXR_BUILD_EXAMPLES OFF CACHE BOOL " " FORCE)
+set(OPENEXR_BUILD_TOOLS OFF CACHE BOOL " " FORCE)
+add_subdirectory(openexr)
+
+if (CMAKE_CXX_COMPILER_ID MATCHES "GNU")
+    # Fix compilation on Linux when code security checks are enabled
+    target_compile_definitions(OpenEXRCore PRIVATE _GNU_SOURCE)
+endif()
+
 # Compile clip
 set(CLIP_EXAMPLES OFF CACHE BOOL " " FORCE)
 set(CLIP_TESTS OFF CACHE BOOL " " FORCE)

src/HelpWindow.cpp

@@ -179,6 +179,9 @@ HelpWindow::HelpWindow(Widget* parent, bool supportsHdr, function<void()> closeC
     addSpacer(about, 20);
 
     addLibrary(about, "args", "", "Single-header argument parsing library");
+#ifdef TEV_SUPPORT_AVIF
+    addLibrary(about, "aom", "", "Alliance for Open Media Video Codec");
+#endif
     addLibrary(about, "clip", "", "Cross-platform clipboard library");
     addLibrary(about, "{fmt}", "", "Fast & safe formatting library");
     addLibrary(about, "Glad", "", "Multi-language GL loader-generator");

src/ImageViewer.cpp

@@ -1735,15 +1735,18 @@ void ImageViewer::toggleHelpWindow() {
 void ImageViewer::openImageDialog() {
     vector<string> paths = file_dialog(
         {
-            // HDR formats
+    // HDR formats
+#ifdef TEV_SUPPORT_AVIF
+            {"avif", "AV1 Image File"                   },
+#endif
             {"exr",  "OpenEXR image"                    },
             {"hdr",  "HDR image"                        },
 #ifdef TEV_SUPPORT_HEIC
             {"heic", "High Efficiency Image Container"  },
 #endif
             {"pfm",  "Portable Float Map image"         },
             // LDR formats
-            {"bmp",  "Bitmap Image File"                },
+            {"bmp",  "Bitmap image"                     },
             {"gif",  "Graphics Interchange Format image"},
             {"jpg",  "JPEG image"                       },
             {"jpeg", "JPEG image"                       },